Developer information - Developing a Business Concept

What is a Business Concept

A Business Concept is:

Directory structure of a business concept

Each business concept is stored within the context in which it is defined. The directory structure for storing business concepts in DEXlib is therefore as follows:

      dexlib/data/busconcept/
      dexlib/data/busconcept/[context]
      dexlib/data/busconcept/[context]/[business_concept]
    

Where [context] is the name of the context and where [business_concept] is the name of the business concept.

An index of the contexts is provided in: dexlib/data/busconcept/context_index.xml

An index of all the business concepts that have been defined within a given context is provided in: dexlib/data/busconcept/[context]/context.xml

Process for building a business concept

The process for building a business concept is as follows.

  1. Identify the context
    If the context exists, (and is identified in dexlib/data/busconcept/context_index.xml) then no action is required.
    If the context does not exist, then create a context.
    1. Create the context
      Run the script: dexlib/utils/dex/mk_context.wsf
      This will create the directory: dexlib/data/busconcept/[context]
      where [context] is the name of the context. It will also create the XML files for the context. In particular: context.xml.
      The file will be populated with the documented XML which you need to complete.
    2. Update index of contexts
      Add the context just created to: dexlib/data/busconcept/context_index.xml
      This lists the contexts that have been defined in DEXlib.
  2. Create the business concept
    Run the script: dexlib/utils/dex/mk_buscpt.wsf
    When prompted, provide the name of the context just identified/created.
    This will create the directory: dexlib/data/busconcept/[context]/[business_concept]
    where [context] is the name of the context and where [business_concept] is the name of the business concept.
    It will also create the XML files for the business concept. In particular: dexlib/data/busconcept/[context]/[business_concept]/busconcept.xml.
    The file will be populated with the documented XML which you need to complete.
  3. Update context index of business concept
    Each context maintains an index of the business concepts defined within that context. So update: dexlib/data/busconcept/[context]/context.xml with the new business concept just created.