corda/docs/source
Dan Newton a477d59c15 CORDA-3094 improvements to checkpoint dumper (#5324)
- Handle errors in Jackson and checkpoint deserialisation. A file
  notifying the user that the checkpoint dump failed is created when
  errors occur.
- Handle message deserialisation errors. A string placeholder is used
  if an error occurs.
- Add more information about subflows (include their `FlowLogic`)
- Increase clarity in checkpoint output field names

* CORDA-3904 Add `flowCallStackSummary`

Add `flowCallStackSummary` to the output which contains the same content
as `flowCallStack` minus each subflow's `FlowLogic`. The `FlowLogic`
contains a ton of info which is normally repeated in each subflow.
Adding the summary gives an overview of the steps the flow executed
and which step it is currently on.

The `suspendedOn` field is put underneath the summary and the original
call stack is moved below the suspended info.

This puts the most useful information towards the top of the json file.
2019-08-14 14:08:58 +01:00
..
_static Docs: sync static versions list in master with release/4 branch 2019-02-25 16:54:30 +01:00
_templates Replaces links to Discourse with Stack Overflow links. 2017-10-30 10:09:08 +00:00
corda-network Update index.md 2019-08-07 14:17:15 +02:00
design Added accounts design doc. (#5193) 2019-07-30 16:17:04 +00:00
example-code Fix tut-two-party-flow kotlin docs + make both versions easier to read (#5024) 2019-04-16 11:06:05 +01:00
resources ENT-2820 Document database tables (#5012) 2019-04-15 11:28:57 +01:00
whitepaper Moves whitepapers. (#3217) 2018-05-22 15:38:43 +01:00
api-contract-constraints.rst Delete unused DuplicateContractClassException (#5284) 2019-07-10 17:01:38 +01:00
api-contracts.rst Fix docs on branching verify with commands 2018-11-28 22:25:21 +00:00
api-core-types.rst [CORDA-2385] Ensure codesets are included in documentation (#4546) 2019-01-11 09:22:45 +00:00
api-flows.rst Minor updates following RGB feedback. 2019-03-27 17:05:07 +01:00
api-identity.rst Fix documentation issues (#4721) 2019-02-06 12:49:47 +00:00
api-persistence.rst DEVREL-1287 - Minor Typographic Changes 2019-05-08 11:49:23 +02:00
api-rpc.rst CORDA-3028: Add Node Diagnostics Info RPC Call (#5271) 2019-07-08 14:43:50 +01:00
api-scanner.rst corda-2781 replace manual versions with substitutions (#4927) 2019-03-25 12:20:26 +00:00
api-service-classes.rst Add documentation on Corda Services / Service classes (#5079) 2019-05-02 09:42:32 +01:00
api-service-hub.rst Moves code sections in tutorials to code files. 2017-10-01 23:33:15 +01:00
api-states.rst CORDA-2639: CorDapp dependencies documentation (#4798) 2019-05-21 10:45:21 +01:00
api-testing.rst Add constants for the open source and samples repos branch names (#5263) 2019-08-02 09:00:46 +01:00
api-transactions.rst Fix for dodgy formatting of the reference states part of api-transaction.rst (#4495) 2019-01-03 17:22:25 +00:00
api-vault-query.rst CORDA-2432 - Update documentation for filtering by state relevancy in vault queries (#4577) 2019-01-16 19:53:49 +00:00
app-upgrade-notes.rst Delete unused DuplicateContractClassException (#5284) 2019-07-10 17:01:38 +01:00
aws-vm-explore.rst Na testnet explorer docs (#3660) 2018-07-20 16:21:24 +01:00
aws-vm.rst Docs: re-organise the toctree a bit more and introduce a design section 2018-05-15 16:59:35 +02:00
azure-vm-explore.rst Azure OS testnet instructions - minor changes (#3777) 2018-08-17 16:59:52 +01:00
azure-vm.rst Add constants for the open source and samples repos branch names (#5263) 2019-08-02 09:00:46 +01:00
blob-inspector.rst CORDA-1838: Add subcommands to node (#4091) 2018-10-24 13:58:19 +01:00
building-a-cordapp-index.rst Minor tweaks and improvements in docs TOC to aid navigation and access. 2019-03-27 15:26:17 +01:00
building-a-cordapp-samples.rst Re-introduce demo docs (#1981) 2017-11-22 15:39:48 +00:00
building-against-master.rst Adds instructions for building Gradle plugins (#3372) 2018-06-14 15:57:49 +01:00
building-corda.rst Combines all contributing info in one place. Clean-up. (#4266) 2018-11-20 18:17:11 +00:00
building-the-docs.rst CORDA-2808 docs build page (#4947) 2019-03-27 15:40:36 +00:00
changelog.rst CORDA-3071 - Checkpoint agent tool (#5295) 2019-08-01 09:40:52 +01:00
cheat-sheet.rst Minor corrections to the V2 cheatsheet. 2017-12-08 17:00:31 +00:00
checkpoint-tooling.rst CORDA-3094 improvements to checkpoint dumper (#5324) 2019-08-14 14:08:58 +01:00
cipher-suites.rst Docs: repair a lot of broken docs pages. 2019-02-21 12:05:07 +01:00
cli-application-shell-extensions.rst corda-2781 replace manual versions with substitutions (#4927) 2019-03-25 12:20:26 +00:00
cli-ux-guidelines.rst low hanging fruit 2019-03-27 15:25:40 +01:00
clientrpc.rst [CORDA-2923] - Make the RPC client reconnect with gracefulReconnect param (#5244) 2019-07-16 11:29:21 +01:00
codestyle.rst Add a section to the coding guidelines about updating the docsite. 2019-02-11 16:15:05 +01:00
compatibility-zones.rst Updated network docs (#4154) 2018-11-05 15:51:42 +00:00
component-library-index.rst Removed flow-library doc page as it's redundant (#3307) 2018-06-05 21:43:03 +01:00
conf.py Add constants for the open source and samples repos branch names (#5263) 2019-08-02 09:00:46 +01:00
contract-catalogue.rst Pluggable cash selection using H2 as default implementation. (#1300) 2017-08-22 18:09:23 +01:00
contract-irs.rst Further docsite changes, including reorganising the index. 2017-06-07 16:14:01 +01:00
contract-upgrade.rst Document warning cleanup + new version of docs builder 2019-04-11 13:43:47 +00:00
contributing-flow-internals.rst CORDA-3071 - Checkpoint agent tool (#5295) 2019-08-01 09:40:52 +01:00
contributing-flow-state-machines.rst Document warning cleanup + new version of docs builder 2019-04-11 13:43:47 +00:00
contributing-index.rst Documentation of flow framework internals (#4991) 2019-04-29 09:59:36 +01:00
contributing-philosophy.rst Moves Contrib and Network sections up in index. Makes requesting a contribution more prominent. (#4573) 2019-01-14 15:58:00 +00:00
contributing.rst Document warning cleanup + new version of docs builder 2019-04-11 13:43:47 +00:00
corda-api.rst Add documentation on Corda Services / Service classes (#5079) 2019-05-02 09:42:32 +01:00
corda-configuration-file.rst CORDA-1912: Add documentation on the options for deploying nodes (#5183) 2019-06-10 10:24:06 +01:00
corda-networks-index.rst Docs: move the versioning page to the building a cordapp section, as it's more relevant to app devs than network operators. 2018-12-18 12:48:51 +01:00
corda-nodes-index.rst ENT-3161 - Align docs with ENT (#5113) 2019-05-09 17:23:52 +01:00
corda-testnet-intro.rst Updated network docs (#4154) 2018-11-05 15:51:42 +00:00
cordapp-advanced-concepts.rst CORDA-2639: CorDapp dependencies documentation (#4798) 2019-05-21 10:45:21 +01:00
cordapp-build-systems.rst Remove mention of hot swapping of cordapp config files (#5260) 2019-06-27 18:27:36 +01:00
cordapp-constraint-migration.rst CORDA-2280 Automatic propagation of whitelisted to Signature Constraints (#5053) 2019-04-29 17:37:57 +01:00
cordapp-custom-serializers.rst [CORDA-2473] - Remove AMQP system property (#5112) 2019-05-14 13:22:22 +01:00
cordapp-overview.rst CORDA-2656 Docs: building a CorDapp for both OS and Enterprise (#4797) 2019-02-22 10:14:59 +00:00
cordapp-upgradeability.rst CORDA-2684 Added new guide on CorDapp Constraints Migration procedures. (#4837) 2019-03-07 09:32:16 +00:00
debugging-a-cordapp.rst Consolidates and extends debugging information. (#3548) 2018-07-10 15:17:59 +01:00
demobench.rst Document warning cleanup + new version of docs builder 2019-04-11 13:43:47 +00:00
deploy-locally.rst Updated network docs (#4154) 2018-11-05 15:51:42 +00:00
deploy-to-testnet-index.rst Updated network docs (#4154) 2018-11-05 15:51:42 +00:00
deploying-a-node.rst Docs - fix broken link to nssm third-party tool. (#5170) 2019-05-29 15:02:25 +00:00
deterministic-modules.rst Document warning cleanup + new version of docs builder 2019-04-11 13:43:47 +00:00
docker-image.rst CORDA-2888 change default dataSource.url to match the docker container structure. (#5098) 2019-05-07 10:32:47 +01:00
event-scheduling.rst Docs: repair a lot of broken docs pages. 2019-02-21 12:05:07 +01:00
financial-model.rst [CORDA-2385] Ensure codesets are included in documentation (#4546) 2019-01-11 09:22:45 +00:00
flow-cookbook.rst Various clean ups of the docs example code (#3982) 2018-09-24 15:00:31 +01:00
flow-overriding.rst DEVREL-1287 - Minor Typographic Changes 2019-05-08 11:49:23 +02:00
flow-state-machines.rst Docs: repair a lot of broken docs pages. 2019-02-21 12:05:07 +01:00
flow-testing.rst [ENT-1955] Documentation fixes (#3417) 2018-06-21 16:57:30 +01:00
gcp-vm.rst Na testnet explorer docs (#3660) 2018-07-20 16:21:24 +01:00
generating-a-node.rst Add constants for the open source and samples repos branch names (#5263) 2019-08-02 09:00:46 +01:00
getting-set-up.rst Update set-up docs based on recent practical experience. 2019-06-03 11:01:54 +02:00
hello-world-flow.rst CORDA-2423 document draining requirements in flow state machines (#4707) 2019-02-05 14:19:08 +00:00
hello-world-introduction.rst Updates tutorial to reflect new template structure. Clean-up. (#4216) 2018-11-13 11:50:24 +00:00
hello-world-running.rst Docs update: fixed vaultQuery command in Hello World tutorial (#5182) 2019-06-03 08:57:26 +00:00
hello-world-state.rst StatesAndContracts.kt is now TemplateContract.kt (#4972) 2019-04-26 19:53:30 +01:00
hello-world-template.rst Cais r3 doc fixes (#4974) 2019-04-02 11:20:12 +01:00
index.rst revision of deploy 2019-07-12 10:51:12 +02:00
joining-a-compatibility-zone.rst Updated network docs (#4154) 2018-11-05 15:51:42 +00:00
json.rst Fixes docsite dead links. 2017-09-29 17:42:49 +01:00
key-concepts-consensus.rst [CORDA-1612]: Fix truncated code snippets in docs PDF (#3347) 2018-06-13 09:43:16 +01:00
key-concepts-contracts.rst Applied JD changes 2019-05-08 11:49:23 +02:00
key-concepts-djvm.rst CORDA-2961: Migrate the DJVM into its own repository. (#5166) 2019-05-24 15:09:20 +01:00
key-concepts-ecosystem.rst DEVREL-1297 Ledger - Doc Site Lessonly Conformance (#5128) 2019-05-21 14:59:11 +01:00
key-concepts-flows.rst [CORDA-1612]: Fix truncated code snippets in docs PDF (#3347) 2018-06-13 09:43:16 +01:00
key-concepts-ledger.rst DEVREL-1297 Ledger - Doc Site Lessonly Conformance (#5128) 2019-05-21 14:59:11 +01:00
key-concepts-node.rst Docs: introduce a page about upgrading the node. 2019-02-21 12:05:07 +01:00
key-concepts-notaries.rst Docs: update notary setup page 2018-07-17 11:26:55 +02:00
key-concepts-oracles.rst CORDA-1514 Add our patented nested Merkle trees protocol to documentation 2018-07-17 15:36:10 +01:00
key-concepts-states.rst Added more docs for reference states to key concepts and api docs. (#4013) 2018-10-02 16:29:19 +01:00
key-concepts-tearoffs.rst CORDA-1514 Add our patented nested Merkle trees protocol to documentation 2018-07-17 15:36:10 +01:00
key-concepts-time-windows.rst [CORDA-1612]: Fix truncated code snippets in docs PDF (#3347) 2018-06-13 09:43:16 +01:00
key-concepts-tradeoffs.rst Minor changes to text to more accurately reflect the current implementation. (#3477) 2018-07-02 10:26:33 +01:00
key-concepts-transactions.rst DEVREL-1287 - Minor Typos & Commands info in "Other transaction components" intro 2019-05-08 11:49:23 +02:00
key-concepts-vault.rst Minor tweaks and improvements in docs TOC to aid navigation and access. 2019-03-27 15:26:17 +01:00
key-concepts.rst DEVREL-1297 Ledger - Doc Site Lessonly Conformance (#5128) 2019-05-21 14:59:11 +01:00
loadtesting.rst Document warning cleanup + new version of docs builder 2019-04-11 13:43:47 +00:00
messaging.rst ENT-2168: Node internal docs tweaks (#3624) 2018-07-16 17:13:43 +01:00
network-bootstrapper.rst DOCS - Point network bootstrapper url to the artifactory download location (#5316) 2019-07-24 15:30:27 +01:00
network-builder.rst CORDA-2998 fix network builder (#5265) 2019-07-02 11:32:48 +01:00
network-map.rst CORDA-2779 - Fix Netmap REST endpoint docs (#4918) 2019-03-22 15:57:55 +00:00
node-administration.rst CORDA-3028: Add Node Diagnostics Info RPC Call (#5271) 2019-07-08 14:43:50 +01:00
node-commandline.rst low hanging fruit 2019-03-27 15:25:40 +01:00
node-database-access-h2.rst Joel upgrade docs (#3730) 2018-08-03 13:34:34 +01:00
node-database-tables.rst Database Tables doc fix: Change paragraphs heading, so they don't appear as top level in the side bar; fix a web page link. (#5123) 2019-05-14 14:30:08 +01:00
node-database.rst ENT-2820 Document database tables (#5012) 2019-04-15 11:28:57 +01:00
node-explorer.rst ENT-3128: Update documentation for Node Explorer. (#4817) 2019-02-27 14:32:39 +00:00
node-flow-hospital.rst [DOCS] - Clarify behaviour of hospital in unhandled errors (#5366) 2019-08-14 11:24:43 +01:00
node-internals-index.rst Minor tweaks and improvements in docs TOC to aid navigation and access. 2019-03-27 15:26:17 +01:00
node-naming.rst More fixes 2019-01-14 10:07:51 +00:00
node-operations-upgrade-cordapps.rst ENT-3161 - Align docs with ENT (#5113) 2019-05-09 17:23:52 +01:00
node-services.rst ENT-2168: Node internal docs tweaks (#3624) 2018-07-16 17:13:43 +01:00
node-structure.rst Another file adjusted 2019-01-14 10:55:39 +00:00
node-upgrade-notes.rst CORDA-2511 Upgrade notes for C4 need to include required minimum previous Corda version (#5039) 2019-05-13 18:24:53 +01:00
oracles.rst Docs: repair a lot of broken docs pages. 2019-02-21 12:05:07 +01:00
permissioning.rst Updated network docs (#4154) 2018-11-05 15:51:42 +00:00
quickstart-build.rst last update 2019-07-12 10:51:12 +02:00
quickstart-deploy.rst last update 2019-07-12 10:51:12 +02:00
quickstart-index.rst last update 2019-07-12 10:51:12 +02:00
release-notes.rst Document warning cleanup + new version of docs builder 2019-04-11 13:43:47 +00:00
running-a-node.rst CORDA-2617: Add failover listeners to terminate node process (#5337) 2019-08-06 11:28:16 +01:00
running-a-notary.rst Add constants for the open source and samples repos branch names (#5263) 2019-08-02 09:00:46 +01:00
secure-coding-guidelines.rst Docsite reorg ahead of beta launch. 2017-06-05 13:37:23 +01:00
serialization-default-evolution.rst LedgerTransaction no longer a data class to prevent more copy methods and fixed serialisation issue (CORDA-2231) (#4287) 2018-11-22 22:53:24 +00:00
serialization-enum-evolution.rst [CORDA-2385] Ensure codesets are included in documentation (#4546) 2019-01-11 09:22:45 +00:00
serialization-index.rst Add some documentation on the wire format. 2019-06-03 14:56:21 +02:00
serialization.rst Add some documentation on the wire format. 2019-06-03 14:56:21 +02:00
setting-up-a-dynamic-compatibility-zone.rst Updated network docs (#4154) 2018-11-05 15:51:42 +00:00
shell.rst ENT-3965 Improved welcome message for Standalone Shell - bye command to exit shell only, docs clarifications gracefulShutdown/shutdown needs 'run' as other commands (#5363) 2019-08-12 13:22:15 +01:00
soft-locking.rst Improvements to Vault Query Service soft locked state querying (#1174) 2017-08-04 17:23:31 +01:00
testing.rst CORDA-2821 Fix issue with Quasar errors redirecting to useless page (#4982) 2019-04-25 15:34:05 +00:00
testnet-explorer-corda.rst Document warning cleanup + new version of docs builder 2019-04-11 13:43:47 +00:00
tools-index.rst CORDA-3071 - Checkpoint agent tool (#5295) 2019-08-01 09:40:52 +01:00
troubleshooting.rst Removes the glossary and FAQ. Points people to StackOverflow for troubleshooting. 2018-03-16 13:41:38 +00:00
tut-two-party-contract.rst Cais r3 doc fixes (#4974) 2019-04-02 11:20:12 +01:00
tut-two-party-flow.rst Fix tut-two-party-flow kotlin docs + make both versions easier to read (#5024) 2019-04-16 11:06:05 +01:00
tut-two-party-introduction.rst Fix typos (#4317) 2018-12-03 22:30:15 +00:00
tutorial-attachments.rst Document warning cleanup + new version of docs builder 2019-04-11 13:43:47 +00:00
tutorial-building-transactions.rst Update tutorial-building-transactions.rst 2019-03-02 17:45:34 +01:00
tutorial-clientrpc-api.rst Various clean ups of the docs example code (#3982) 2018-09-24 15:00:31 +01:00
tutorial-contract.rst Contract tutorial update and Contributors list update (#5338) 2019-07-30 14:51:34 +01:00
tutorial-cordapp.rst Update tutorial cordapp (#5192) 2019-06-07 14:30:10 +01:00
tutorial-custom-notary.rst Add MockNet support for custom Notary class 2019-07-17 13:24:04 +02:00
tutorial-integration-testing.rst CORDA-2729: Update integration testing instructions to explicitly mention node-driver dependency (#4873) 2019-03-12 10:25:39 +00:00
tutorial-observer-nodes.rst [CORDA-2086] Allow transactions to be re-recorded using StatesToRecord.ALL_VISIBLE (#5184) 2019-07-04 14:00:42 +01:00
tutorial-tear-offs.rst Docs: repair a lot of broken docs pages. 2019-02-21 12:05:07 +01:00
tutorial-test-dsl.rst Document warning cleanup + new version of docs builder 2019-04-11 13:43:47 +00:00
tutorials-index.rst Docs: update notary setup page 2018-07-17 11:26:55 +02:00
upgrading-cordapps.rst Update upgrading-cordapps.rst (#5274) 2019-07-04 10:07:33 +01:00
versioning.rst Delete unused DuplicateContractClassException (#5284) 2019-07-10 17:01:38 +01:00
wire-format.rst Wire format docs: review fixes from Rick. 2019-06-03 14:56:21 +02:00
writing-a-cordapp.rst Document warning cleanup + new version of docs builder 2019-04-11 13:43:47 +00:00