Snippet Management

The following screens demonstrate how to:

1. Access and view snippets

2. Create a local standard snippet, or a local class snippet

3. Create and modify a local copy of a remote standard or class snippet

Terminology

● Standard Snippet - the main purpose of a snippet is to capture the configuration of a use case by changing the values of selected configuration parameters of some of the modules. All of the modules are available to configure within a single snippet. Such snippets (sets of configured parameters) can then be easily reused for a fast configuration in multiple deployments.

– Singleton Module is a standalone, working system component that provides a set of unique features within the OpenHRETM system.

● Class Snippet represents an instance of a class module with its own configuration parameter values.

– Class Module is a template for creating multiple instances of a module, where a new instance is specified by evaluation of the configuration parameters of the class module.

● Remote Snippet is a non-editable example of a snippet provided by a particular OpenHRETM release.

● Local Snippet is an editable, local snippet created by administrators to match customer OpenHRETM requirements.

Refer to the Deployment Management.pdf documentation for more information about snippets.

Accessing the System (1/7)Log-in, Snippets Library

To access the Deployment Management UI application,

in a web browser, enter https://<your.configurationserver.org>:8081 and press ENTER.

Note: You must use a secure SSL connection to access the system.

To access the Deployment Managemententer the appropriate information in

the User name and the Password fieldsand click the Log in button.

To access snippets, click the Snippets tab.

List of localsnippets displays.

Note: Local snippetsare prefixed with local@.

Note: Release drop-down lists are prefilledwith the latest release available on the Release Server.

Select a release and sub-release in the Release drop-down listto specify the release that is preloaded on the Release Server.

Specified releases are used- to provide remote snippets (examples of the snippets) for Deployment Management

- to provide remote deployments (examples of the deployments) for Deployment Management- as a source of binaries to deploy OpenHRETM.

Creating a New Local Standard Snippet (2/7)…from scratch

To create a new, editable, local standard snippet, click the Add button.

Fill in the Id and Name fields.

To create a new, local standard snippet, click the

Add button.

Note: Leave the Module field blank for standard snippets.

Note: You are now maintaining a newly created local standard snippet.

Note: Each module has its default configuration,which can by modified manually.

Refer to following sections for information on how to:● modify a standard snippet manually● maintain a snippet● create a new snippet as a copy of the sample remote snippet.

Creating a New Local Standard Snippet (3/7)…as a copy of a sample remote standard snippet

To display examples of snippets for a selected release, select the Show remote snippets check box.

To access a non-editablesample standard snippet,

select a snippet from the list.Note: Module field (if specified) displays the class module name

from which a class snippet is instanced.

Note: A snippet with no specified Module field displays a standard snippet.

To review the module parameters select the Module.

Note: Since you cannot edit remote (sample) snippets, you cannot change module parameters.

The number in square brackets displayshow many module parameters were changed

but does not contain the default value.

Parameters in bold specify parameters withchanged default values.

To create a local copy of the snippet example that serves as an editable

customer-specific snippet, click Copy button.

To reach the end of the list of module parameters, scroll down the page.

Note: There is a postfix_copy added at the end of the Id field.Enter the appropriate information in the Id field to change it.

Note: There is a postfix Copy added at the end of the Name field.Enter the appropriate information in the Name field to change it.

To create a local copy of the snippet example, click the Copy button.

Local Standard Snippets (4/7)Rename, Copy, Delete, Edit, …

Note: You are now maintaining a newly created, local snippet.

To directly delete a newly created local snippet and return to the List of snippets,

click the Delete button.

To create another copy of the newly createdlocal snippet, click the Copy button.

To rename a newly created localsnippet, click the Rename button.

To return to the List of snippets,click the Cancel button.

You can also click the Snippet List link to directly delete a newly created local

snippet and return to the list of snippets.

Note: To exit the snippet without saving changes since the previous Save, click the Cancel button or

click the Snippet List link.

or click the Save button to save changes before returning to the

Snippet List.

To access and modify a selected module, select the module.

The number in square brackets displayshow many module parameters were changed

but does not contain the default value.

Parameters in bold specify parameters withchanged default value.

Note: To return to default value, click the icon to the right of the parameter

For example, to change the default value of theGlobal UI theme, click the Global UI theme drop-down

list and select a theme.

The following screens show how to modify a drop-down list type of parameters.

The number of the changed parametersincreases by one.

Changed parameters display in boldwith icon to the right allowing you to

return to the default value.

The following screens show how to modify a drop-down list type of parameters.

To reach the end of the list of module parameters, scroll down the page.

To save the changes to the editable and customized local snippet, click the Save button.

To access and modify a selected module, select the module.

The following screens show how to modify the directory type of a parameter.

Note: The MPI customization directory field contains two options:no folder - which specifies that there is no MPI customization

as there is no MPI customization directory specified.uk - which specifies that uk is the name of the MPI customization directory.

Note: Since the prefilled uk directory is a remote (example) directory,it is not possible to access and modify it.

Deployment management allows you to create anew, editable, local directory.

To add another option to the MPI customization directory drop-down list,complete following steps:

- access the system with Deployment Management installed- create the ./configurator/data/localrepo/dirs/mpi/

<customization> directory- copy the customization file to the <customization> directory

or its subdirectory.

To find the MPI customization directory, scroll down the page.

The new local (prefixed with local@)option,representing a new local customization directory, displays.

To reach the end of the list of module parameters, scroll down the page.

To save the changes to the editable and customized local snippet.

click the Save button.

A new editable and customizedlocal copy of the snippet displays.

Creating a New Local Class Snippet (5/7)…from scratch

To create a new, editable local class snippet, click

the Add button.

Fill in the Id and Name fields.

To create a new, local class snippet, click

the Add button.

Note: To create a class snippet, select a module fromThe drop-down list.

For example, IHE Partner (PDQ/XDS).

Note: You are now maintaining a newly created local class snippet.

Note: Each class module has its default configuration, which can by modified manually.

Refer to following sections for information on how to● modify a class snippet manually● maintain a class snippet● create a new class snippet as a copy of the sample remote class snippet.

Creating a New Local Class Snippet (6/7)…as a copy of a sample remote class snippet

To access a non-editablesample class snippet,

select the snippet.

To display examples of snippets for a selected release, select the Show remote snippets check box.

Note: Class snippet consists of a one specific module.

The number in square brackets displayshow many module parameters were changed

but does not contain the default value.

To review the module parameters, click the Module.

To reach the end of the list of module parameters, scroll down the page.

To create a local copy of the class snippet example that serves as an editable,

customer specific class snippet, click the Copy button.

Note: There is a postfix _copy added at the end of the Id field.Enter the appropriate information in the Id field to change it.

Note: There is a postfix Copy added at the end of the Name field.Enter the appropriate information in the Name field to change it.

To create a local copy of the class snippet example, click the Copy button.

Local Class Snippets (7/7)Rename, Copy, Delete, Edit, …

Note: You are now maintaining newly created local class snippet.

To directly delete the newlycreated local class snippet and return to the List of snippets,

click the Delete button.

To create another copy of the newly created local class snippet,

click the Copy button.

To rename a newly created localclass snippet, click the Rename button.

To return to the List of snippets,either click the Cancel button

You can also click the Snippet List link to delete the newly created local class

snippet and return to the list of snippets.

Note: If you click the Cancel button or the Snippet List link,you will leave the snippet with unsaved changes from the last Save.

or click the Save button to save your changes before returning to the

list of snippets.

To access and modify a selected module, click the module.

The following screens show how to modify a numeric type of parameter.

The Registry WS Settings Port displays the numeric parameter.

For example, to change the default value of theRegistry WS Settings Port number, click the

UP arrow in the Port field.The number of the changed parameters

increases by one.

Changed parameters display in boldwith an icon to the right that allows you

to return to the default value.

To reach the end of the list of module parameters, scroll down the page.

To save the changes in the editable and customized local class snippet,

click the Save button.

The Snippets list also displays a new class snippet currently created.- Default XDS Gateway Instance Copy class snippet

Note: You can now use the newly created snippets in deploymentsto create configurations and deploy OpenHRETM.

Refer to the Configuration Management presentation for more information on how to configure deployments using snippets.

SummaryStandard snippets capture the configuration of a reusable use case that spans over multiple singleton modules. A snippet (a set of values) can be then quickly applied to multiple deployments.

Class snippets represent instances of class modules. They can be also reused in multiple deployments (e.g., external partners, tunnels, etc.).

Both standard and class snippets can be created from scratch, or as a copy of an existing (local or remote) snippet.

In the next presentation we will demonstrate that a real system instance is created as a combination of singleton modules, snippets, class snippets, and manual adjustments. Such prepared instance can be then remotely deployed to a target server using a single click of a button.