User Tools

Site Tools


implementation:wms:generate_doc_tool

Generate documentation tool

Use the ’Generate documentation’ tool to export the structure of Produmex related database tables, indexes and user defined fields into a html file.

Go to the installation folder: Produmex > Produmex Tools and run the Produmex.Sbo.Logex.Tools.GenerateDocs.exe file. Make sure that you run it in Administrator mode.

Check the connection string on the screen and adjust it if necessary in the configuration file of the tool: Produmex.Sbo.Logex.Tools.GenerateDocs.exe.config.

Click on the ’SAP tables doc’ button to start the export.

The tool exports the following:

  1. If a table name contains the ’PMX_’ or the ’@PMX_’ prefix, but does not contain the ’PMX_ADDON’ alias, then the tool exports the following for that table:
    • table name
    • column name
    • data type
    • character maximum length
    • numeric precision
    • numeric scale
    • is nullable value (Y/N)
    • column default value
    • primary key
  2. If the name of a database index contains the ’PMX_’ prefix, the tool exports the following for that index:
    • table name
    • index name
    • type description
    • is primary key value (Y/N)
    • is unique value (Y/N)
    • is unique constraint (Y/N)
    • key ordinal
    • column name
    • is included column (Y/N)
  3. If the name of a user defined field contains the ’PMX_’ prefix, the tool exports the following for that user defined field:
    • table name
    • column name
    • data type
    • is nullable value (Y/N)
    • character maximum length
    • numeric precision
    • numeric scale
    • description
    • type ID
    • edit type
    • edit size
    • default value
    • index ID
    • field value
    • field value description

The html file is exported to the folder of the Generate Doc tool.

implementation/wms/generate_doc_tool.txt · Last modified: 2018/06/05 09:09 by csuhaa