Update Company Templates

The purpose with this document is to provide a short guideline how update a company template with new data.

How to implement a Logical Unit to support the company template concept is not covered. Please refer to the Implement Company Template document for more information about implementation details.

This document covers the following scenarios

  1. Adding a new Logical Unit to a company template.
  2. Adding a new attribute in a Logical Unit to a company template.
  3. Add new template data to a company template

 Note: Only application owner or a user that has been set up as a Company Template Super User in the Company Template Super User Administration form, can update a system template.

Contents

Adding a New Logical Unit to a Company Template - Alternative 1

This section covers how to update a company template when adding a new Logical Unit that should support the company template concept, by directly adding the template data in Company Template specific windows.

  1. Update the file CreateCompanyReg<component>.ins file with all the data needed for the new Logical Unit.

  2. Set the properties DbImplementation and CompanyCopyColumnName in the entity file and the business logic will be automatically generated.

    Please refer to the Implement Company Template document for more information.

  3. Open the Company Template Lu window by using RMB Company Template Component followed by RMB Company Template Lu, starting from the Company Templates window.
  4. Add the new Logical Unit by using List of Values or enter manually and save.

    Note: Only Logical Units that have been registered through the CreateCompanyReg<component>.ins file will be possible to choose.

  5. Enter the Company Template Detail window by using RMB on the Company Template Lu window.
  6. Enter the data for the Logical Unit and Save.
  7. Validate the data entered using the business logic created in the Logical Unit by creating a company based on the updated company template.
  8. Export the template.
  9. Deploy the template file into the database using SQL*Plus or Import or using the Import Company Template File Assistant .
  10. Validate the updated template by creating a company based on the updated company template. It is important to ensure that all steps work as expected
  11. Check in the modified template file into the version handling system.

Adding a New Logical Unit to a Company Template - Alternative 2

This section covers how to update a company template when adding a new Logical Unit that should support the company template concept, by adding data for a new Logical Unit in a company and then creating the template from the updated company.

  1. Update the file CreateCompanyReg<component>.ins file with all the data needed for the new Logical Unit.

  2. Set the properties DbImplementation and CompanyCopyColumnName in the entity file and the business logic will be automatically generated.

    Please refer to the Implement Company Template document for more information.

  3. Create a new company from the template that is subject to update, e.g. Template Id STD.
  4. Verify that the company was created without errors in the component containing the new Logical Unit.
  5. Go to the Component Registration window to find the Navigator Entry that represents the window for the new Logical Unit. Open this window. Make sure that the current company is the company that was previously created.
  6. Add all data for the new Logical Unit in the window and Save.
  7. Create a template from the company by using the Create Company Template Assistant. Define Template ID, Description and Source Company. The Template ID can be any unused ID at this point, e.g. TEMP, and with Description defined as the string temp.

    Specify the Source Template ID to be used as a source to get User Related Data.

  8. Create a new company from the new template (e.g. TEMP) to make sure that the template is ok. Check the Create Company Component Log for errors.
  9. If not ok, there is probably something wrong with the business logic, e.g. the Export or the Import methods. Correct the logic/errors and perform the previous two steps until there are no errors.

    It is of course possible to remove the temporary template before starting the correction steps.

  10. Export the company template. It is only necessary to export the component that contains the new Logical Unit.
  11. When the template file has been exported, open the file from disk and edit the Template ID and Description to the values of the initial template to be modified, e.g. the STD template.

    Note: The Template ID is a define variable found in the top of the file and the Description is stated a few rows down.

    If .e.g. the template to be modified has the identity STD, then e.g. change identity from TEMP to STD in the file.

  12. Deploy the template file into the database using SQL*Plus or Import by using the Import Company Template File Assistant .
    13. Validate the updated template (e.g. STD) by creating a company based on the updated company template. It is important to ensure that all steps works as expected.
  13. Check in the modified template file into the version handling system.

Adding a New Attribute in a Logical Unit to a Company Template

This section covers how to update a company template when adding a new attribute to an existing Logical Unit that supports the company template concept.

  1. Update the file CreateCompanyReg<component>.ins file with all the data needed for the new attribute.

  2. Set property CompanyCopyColumnName for the attribute in the entity file and the business logic will be automatically generated.

    Please refer to the Implement Company Template document for more information.

  3. Start the window Company Template Detail with respect to the Logical Unit to be updated with data.

    The window is found from the Company Templates window by using RMB Company Template Component followed by RMB Company Template LU followed by RMB Company Template Detail.

  4. Add necessary data in the form and save.
  5. Validate the data entered with the business logic created in the Logical Unit by creating a company based on the updated company template.
  6. Export the template.
  7. Deploy the template file into the database using SQL*Plus or Import by using dialog Import Company Template File Assistant.
  8. Validate the updated template (e.g. STD) by creating a company based on the updated company template. It is important to ensure that all steps works as expected.
  9. Check in the modified template file into version handling system.

Adding New Data to a Company Template

This section describes how to add data to a company template, e.g. adding posting control data for a company template. To be able to update the template by the instructions given here, the user must have permission to update the template.

A System Template can only be updated by application owner or by a Company Template Super User.

End user templates, i.e. non System Templates, can only be updated by the owner of the template (Created By) or by a Company Template Super User.

  1. Before starting to modify the template, make sure that the template is based on the latest version of the template in the version handling system. The reason for this is to make sure that no data is lost if running a different version of the template than the latest.

    To be really sure that the template to be updated is based on the latest version in the version handling system, it is recommended to checkout the latest version and install it using SQL*Plus or the Import Company Template File Assistant. 

  2. Start the Company Template Detail window with respect to the Logical Unit to be updated with data.

    The window is found from the Company Templates window by using RMB Company Template Component followed by RMB Company Template LU followed by RMB Company Template Detail.

  3. In the Company Template Detail window, edit or add new rows.
  4. Press Save to save the changes.
  5. Since the data is not validated against the business logic at this stage, it is only template data, the changes needs to be validated. The easiest and best way to do the validation is to create a new company based on the modified template.
  6. When the new company is created the template data will be validated by the business logic for all active Logical Units. This means that the template data will be validating with respect to data integrity.
  7. Check the Create Company Component Log for errors. If there are errors then make the proper changes and create a company again to validate. Run this step until it looks ok.
  8. After validating that everything looks and works as expected then run the Export Company Template to File Assistant to export the template. This step should be performed per component.
  9. Check in the new version of the template, for each component, into the version handling system to complete the task.

Note: It is possible to manually modify the template files but it is NOT recommended.

Remember that a company template should always be validated by running the Create Company Assistant or by executing Update Company in the Company window.

Note: Only active Logical Units will be processed during the Create Company creation. Active Logical Units can be set and displayed in the Component Registration window.