1. STAEDEAN documentation guidelines and processes
  2. Documentation processes
  3. Publish documentation for D365 F&SCM

Publish documentation and task guides to LCS

When STAEDEAN releases a product version, the relevant task guides must be included in the release. This is done, using a library in the Business process modeler in LCS.
The product documentation and task guides, as created in RapidValue, serve as source for creating the library in LCS.

This flow explains how to publish To-Increase documentation and task guides for D365 F&SCM to LCS.

Note: Usually, you develop the documentation of a STAEDEAN D365 F&SCM product on the product's environment (can be a test or demo environment). Publish documentation and task guides to LCS from the product VM.


Technical writer Technical writer Start Start Export business processes to LCS Export business processes to LCS The product documentation and task guides, as created in RapidValue, serve as source for creating the library in LCS. To create a project library in the LCS Business process modeler, export the relevant business processes from RapidValue to LCS. NOTE: Usually, you develop the documentation of a STAEDEAN D365 F&SCM product on the product's environment (can be a test or demo environment). Publish to LCS from this environment! If you publish to LCS from another environment than the product's environment, the task guides are not published. Procedure 1. Click Business process modeling. 2. Click the Business processes tab. 3. Click LCS. 4. Click Export business processes. 5. In the LCS project field, select the LCS project to which the documentation and task guides must be published. 6. Define the name of the library to which the documentation and task guides are published. The library name must be: [Product name] documentation ([Month] [Year]) Example: Security and compliance studio documentation (June 2020) In the LCS library name field, type a value. Note: For long product names, the full name does not fit in the field. In this case, enter the full name in LCS after the export is finished. 7. In the Export Options field, enter 'Export full BPH'. 8. Click Next. 9. Click Finish. Review created project library in LCS Review created project library in LCS If you have exported business processes from RapidValue to LCS, a project library is created based on the:Business process hierarchy: for each business process, a process node is added to the library.Task guides as defined for the activities in the flows of the business processes: these task guides are added as the lowest process nodes to the business-process-related process nodes.Before you publish the created project library in LCS, review the created project library.Check at least if:For each business process, a process node is added with the related flow description.For each task guide a process node is added with the activity description.Each task guide is uploaded. If not, upload the task guide manually.If the task guide is not uploaded, the Diagram field is empty! Procedure 1. Open LCS. 2. Open the applicable LCS project. 3. Open the Business process modeler. 4. In the Project libraries, in the applicable library tile, click the menu and click Edit. 5. In the dialog, edit the library name and click Save. Note: The library name must be: [Product name] documentation ([Month] [Year]). Example: Security and compliance studio documentation (June 2020). 6. In the Project libraries, open the applicable library (click the link in the library tile). 7. Select the top process node, and in the Overview pane, click Mark as reviewed. Publish reviewed project library to corporate library Publish reviewed project library to corporate library If the project library is reviewed, publish it. As a result, the project library is copied to the corporate libraries.Make sure, the project library stays as well! Procedure 1. Open LCS. 2. Open the applicable LCS project. 3. Open the Business process modeler. 4. In the library tile, click the menu and click Publish. 5. In the dialog, leave the library name unchanged and click Publish. Approve published corporate library Approve published corporate library To make a published corporate library available for use by others, you must approve it.Note: You need admin rights for LCS to approve corporate libraries. Procedure 1. Open LCS. 2. Open the applicable LCS project. 3. Open the Business process modeler. 4. In the Corporate libraries, in the applicable library tile, click the menu and click Approve. Check if the approved corporate library is added to asset library Check if the approved corporate library is added to asset library If published and approved, the library must be available in the LCS project's Asset library. Check if this is the case. Procedure 1. Open LCS. 2. Open the applicable LCS project. 3. Open the Asset library (click the Asset library tile). 4. Check if the library is shown in the BPM artifacts. Inform the team that the corporate library is available Inform the team that the corporate library is available If a library is published and approved in LCS, notify the team. The new library must be included in the official release of the product. End End

Activities

Name Responsible Description

Export business processes to LCS

Technical writer

The product documentation and task guides, as created in RapidValue, serve as source for creating the library in LCS.

To create a project library in the LCS Business process modeler, export the relevant business processes from RapidValue to LCS.
NOTE: Usually, you develop the documentation of a STAEDEAN D365 F&SCM product on the product's environment (can be a test or demo environment). Publish to LCS from this environment! If you publish to LCS from another environment than the product's environment, the task guides are not published.

Review created project library in LCS

Technical writer

 		If you have exported business processes from RapidValue to LCS, a project library is created based on the:
  • Business process hierarchy: for each business process, a process node is added to the library.
  • Task guides as defined for the activities in the flows of the business processes: these task guides are added as the lowest process nodes to the business-process-related process nodes.
Before you publish the created project library in LCS, review the created project library.
Check at least if:
  • For each business process, a process node is added with the related flow description.
  • For each task guide a process node is added with the activity description.
  • Each task guide is uploaded. If not, upload the task guide manually.
    If the task guide is not uploaded, the Diagram field is empty!

Publish reviewed project library to corporate library

Technical writer

 		If the project library is reviewed, publish it. As a result, the project library is copied to the corporate libraries.
Make sure, the project library stays as well!

Approve published corporate library

Technical writer

 		To make a published corporate library available for use by others, you must approve it.
Note: You need admin rights for LCS to approve corporate libraries.

Check if the approved corporate library is added to asset library

Technical writer

 		If published and approved, the library must be available in the LCS project's Asset library. Check if this is the case.

Inform the team that the corporate library is available

Technical writer

 		If a library is published and approved in LCS, notify the team. The new library must be included in the official release of the product.