Mask Generation and Compilation Tools

VPLMPosMaskGenerator Syntax

The syntax is as follows:

VPLMPosMaskGenerator [-h]
	         [-m	       <mask_name>]
	         [-addpath 	<additional_mask_file_directory>]
	         [-d 	      <output_directory>]	
          <modeler>  <modeler> ...]

Role of VPLMPosMaskGenerator

Generates the mask file(s) associated to the given modeler(s), in line with metadata and mask inherited from parent modeler (if any).

The attributes of a modeler's entity are retrieved as follows.

If a mask was associated to the parent modeler:

• the mask definition of inherited attributes (from the parent entity in the parent modeler) is retrieved as is
• a mask definition is computed based on attributes local to the modeler's entity.

Otherwise, the mask definition of each modeler's entity is computed on all attributes (inherited or local)

Once generated, the mask file may have to be tuned to match your own requirements, for instance:

• Add authorized values / set a default value
• Change mandatory property (from N to Y)
• Change editable property of attribute usage in the WRITE function
• Change attribute order in a given function
• Etc.

Finally, do not forget to copy generated mask files in the:

<ENOVIAPlatformServer_WEB-INF>/classes/vplm/mask/<mask_name>

directory before compilation.

Example:

VPLMPosMaskGenerator -d /tmp PLMProductDS

This command generates a file named PLMProductDS.mask in directory/tmp taking into account any existing mask definition for inherited attributes (the ones defined in the PRODUCTCFG.mask file) plus the attributes local to the PLMProductDS.metadata.

VPLMPosMaskCompiler Syntax

The syntax is as follows:

VPLMPosMaskCompiler [-h]
	         [-m	       <mask_name>]
	         [-addpath 	<additional_mask_file_directory>]
	         [-d 	      <output_directory>]
	         [-html     <html_directory>]

Role of VPLMPosMaskCompiler

Compiles all <mask_name> mask files located in:

<ENOVIAPlatformServer_WEB-INF>/classes/vplm/mask/<mask_name>

and generates a single <mask_name>.SecurityMask file.

The compilation result log is:

<output_directory>/result.log

This file contains:

• a tree of modelers hierarchy, with the associated mask file
• a summary of errors (sorted by modeler)
• a summary of errors (sorted by category).

If a FATAL error occurrs, the .SecurityMask file CANNOT BE USED.

HTML files are generated in the <html_directory> (if the -html option is used):

_index.html File

This file lists all processed modelers, alphabetically sorted, with the number of fatal errors, errors, and warnings (if any). If the modeler has a mask, there is a link to see it.

Modeler Overview

This view shows:

• the package hierarchy
• the index of entities
• an index table of errors, if some errors were encountered. A link to the highlighted source is provided
• Per entity and function, the html-simulated rendering.

Here is an annotated example for PLMProductDS mask:

Note that the tool does not account for attribute aliases.

This is a colored version of the mask source file, with errors highlighted:

The following table lists detected errors, their severity level and possible cause:

Examples

You have generated your mask file for the PLMProductDS modeler.

You have put this file in the:

docs/javaserver/vplm/mask/DEFAULT

directory of your runtime view. You will use one of the two following equivalent commands to compile the default mask files:

• VPLMPosMaskCompiler
• VPLMPosMaskCompiler -d <current_directory>

The DEFAULT.SecurityMask file is generated in <current_directory>.

Note: no -html option was specified, so no html file was generated.