Document Management

Documents are instances of document definitions. These are uploaded as part of modules. They serve to interact with the user via pages with business data that are not dependent on a model instance.

For more information, refer to the Modeling guide.

Document List

The users can save the documents they are working on. Saved documents can be exported in the XML format and imported back as well. Note that the features are subject to the security right Document:Write.

Listing Saved Document from the Management Perspective

The documents users have saved and are hence probably working on are available in the Saved Documents view.

Listing Saved Document from Management Console

The documents users have saved and are hence probably working on are available on the Saved Documents page.

Document Export

Exporting a Saved Document from the Management Perspective

To export a saved document to XML, do the following:

1. Open the Saved Documents view.
2. Right-click the document and select Export Saved Document State.

You can edit the downloaded XML and then import it back into the document.

Exporting a Saved Document from Management Console

To export a saved document to XML, do the following:

1. Open the Saved Documents view.
2. Click the saved document.
3. Click the Export Saved Document State button.

You can edit the downloaded XML and then import it back into the document.

Exporting a Saved Document from the Command Line

savedDocumentExport exports a saved document

Long Option	Short Option	Description
--host*	-h	host URL
--username*	-u	user name
--password*	-p	password

^{* required parameters}

lsps-runtime/cli-tools$ java -jar lsps-cli-3.3.2039-full.jar savedDocumentExport --host http://localhost:8080 --username admin --password admin --savedDocumentId 33000

Document Import

The users can save the documents they are working on. Saved documents can be exported in the XML format: you can adapt the XML and imported it back. This allows you to manipulate the runtime data of a saved document out of the management tools. Note that the feature is subject to the security right Document:Write.

Important: Importing a corrupt document can cause the system to fail to work with the document.

Importing a Saved Document in the Management Perspective

To import a saved document XML, do the following:

1. Open the Saved Documents view.
2. Right-click the document and select Import Saved Document State.

Importing a Saved Document in Management Console

To import modified data of a saved document back to the server, do the following:

1. Open the Saved Documents view.
2. Click the Import Saved Document State button.

Importing a Saved Document from the Command Line

savedDocumentImport imports a saved document; the document must already exist in the database

Long Option	Short Option	Description
--host*	-h	host URL
--username*	-u	user name
--password*	-p	password
--savedDocumentId*		saved document id
--file*		file with saved document state

^{* required parameters}

java -jar lsps-cli-3.3.2039-full.jar savedDocumentExport --host http://localhost:8080 --username admin --password admin --savedDocumentId 33000