If you have a comment on this topic, contact Aptify Documentation. If you want to return to the Aptify Community Site, please click here.

About the CM Tool Packer Interface

Owned by admin (Deactivated)
Last updated: Jan 27, 2017
7 min read

CM Tool First Release

This is first official release of the Aptify Configuration Migration (CM) Tool. If you have any questions or problems using the tool please contact Aptify Technical Support. Your feedback is appreciated!

When the user selects the Packing option and successfully logs in, the Configuration Management (CM) Tool Packer form is displayed.


PackerForm

The functionality in this form can be broken down into the following sections:

Configuration Information Section

In the Configuration Information section, the configuration migration version and database server details are displayed. The pack name and pack path details are also listed.

Server

The name of the source server. This field is populated based on the information specified at login.

Database

The version of the Aptify source database. This field is populated based the information specified at login.

Config Migration Version

The version of the Configuration Migration Tool installed on the source server.

Pack Name

The name of the pack to be created or modified on the source server. This field is blank when the Packer interface is first opened. This field is auto-populated as you type in the name of the pack in the Folder Selection.  

Pack Path

The location of the pack to be created or modified. This field is auto-populated as you type in the name of the pack in the Folder Selection. 

Folder Selection Section

In the Folder Selection section, the pack name and location is specified.

Pack Name

The name of the pack to be created or modified on the source server.

Pack Path

The location of the pack to be created or modified. Clicking the ellipse launches the Browse for Folder dialog where you can select an existing or create a new folder. If a pack with the same name and location already exists, it will be overwritten unless the Modify Pack option is selected. 

Refresh

Clears the Pack Name and any selected entity or metatdata information essentially "starting over".

Modify Pack

When checked, if a pack with the same name and location exists, the pack will be modified rather than overwritten.

Entities Tab

The Configuration Management (CM) Tool Packer form Entities tab lists the entities in the source Aptify database that support packing. The listed entities are mostly top-level entities. The entities are listed in a grid that provides the ability to include or exclude related objects and metadata for each entity in the packing action. Selected entities are added underneath the Entities folder in the Tree View section. 

 

If a desired entity is not present in the entity grid, an Aptify administrator must enable the SupportPacking attribute for the desired entity. Once that update is complete, the CM Tool must be restarted to make the desired entity eligible for packing.


The entity grid provides the following packing options for each selected entity:

Managing Default Packing Options

By default, when the CM Tool is installed, the Pack Culture Strings and Pack SubTypes options are checked by default. You can specify which options you want to select by default from the Settings option in the top-left corner of the Packer interface. Once an option is checked or unchecked, the option will be included (or excluded) when selecting an entity during the current session and future session.

Note Concerning Making Changes After Selecting an Entity: The interface needs to refresh when making changes to the select packing defaults. If you have already selected an entity and then change the default option, your selections will not be saved.

 

  • Pack Dependent Entities: selecting this option adds all of the dependent entities and all of their dependent entities to the pack, as identified in the Required Entities tab for this entity in Aptify. This option includes all of the related metadata for the full set of dependent entities as well.
  • Pack Linked Entities:sSelecting this option adds all of the entities that are related to the selected entity as linked fields or as virtual fields, and all of their linked and virtual fields to the pack. This option includes all of the related metadata for the full set of linked and virtual fields.
  • Pack Culture Strings: this option is selected by default. Selecting this option adds all of the Culture Strings records fir the selected entity (or entities).
  • Pack SubTypes: this option is selected by default. Selecting this option adds all of the sub-types for the selected entity (or entities) and all of their sub-types to the pack.
  • Pack Form Template: selecting this option adds all Form Templates and all their related data (i.e., Form Template Parts and Form Templates Categories) for the selected entity (or entities).
  • Pack Process Flow: selecting this option fetches all the process flows and all their related data (i.e., event handler, etc.) for the selected entity (or entities).
  • Pack Dependent DB Objects: selecting this option adds the entire set of related database objects, as identified in the DB Objects tab for the selected entity (or entities).
  • Pack Applications: selecting this option adds all applications and their related data for the selected entity (or entities) 
  • Pack Users:  selecting this option adds all the users for the selected entity (or entities).
  • Pack User Groups: selecting this option adds all the user groups for the selected entity (or entities).
  • Pack Repository Objects: selecting this option fetches all repository objects and their related data assigned to this entity.

 

The Entity grid does provide ability to select multiple entities at once using the Select All option (check box in top-left corner of grid). You can select up to 10 entities at once. Selecting several entities at once can take several minutes to process before it can be displayed.

Metadata Tab

The information on the Metadata tab is displayed in two parts. The left-column displays a grid of all metadata categories (i.e. entities) in the source Aptify database that support packing. The right-column displays the related metadata records for the selected metadata category (entity), broken down into tabs for each of the metadata categories (entities) selected from the left column. Users can select metadata records to be included in the pack. Selecting a record from the Metadata tab causes the Tree View listing of the record to be updated to indicate the selection.

The Metadata tab also includes Search fields for each column that can be used to search for a specific entity or metadata record manage the data to packed.

Adding Metadata Records From the Metadata Tab

When a user selects metadata records through the Metadata tab, the CM Tool handles those records separately from any parent object (i.e. an entity). This means that if a parent entity is removed from the to be packed items, any manually added metadata record remains as part of the pack. For example, if a user adds the Addresses entity from the Entities tab, its related metadata is automatically added to be packed. If the user then adds the USA Address form template in the Metadata tab (i.e. the form templates were not included as a packing option), the CM Tool treats that record as separate metadata and a link from the Addresses entity to that record is established. If the user later removes the Addresses entity from the packing process, its related metadata is removed. However, the manually added USA Address form template metadata record remains. Any metadata records added manually through the Metadata tab for packing can only be removed manually. 

Validation Summary Tab

The Validation Summary tab contains a list of validations rules (both stock and custom as needed) and provides the ability to run the validation rules against the items to be packed before initiating the packing process. You can select a particular rule or set of rules or select all. Clicking the Validate button starts the validation process. You can also chose to Print (or send the errors to PDF, etc.) the results as well.

Validation Summary

This tab also provides the ability to define new validation rules based on user requirements. See Understanding the CM Tool Validation Rules for more information.

Pack Log Tab

The Configuration Management (CM) Tool Packer form Pack Log tab displays details about the internal processes that are executing while the selected data is being packed. The pack log can be used to track the items that have been packed and to troubleshoot any packing problems.

Pack Log Tab

  • Details on any exceptions that occur while packing data are displayed in red.
  • During the packing process, the packing details are automatically saved in text format (.txt in the top-level pack directory.
  • After the packing action is completed, the pack log is saved as NameofPackLog.rtf in the top-level of the pack directory, and the text format log is deleted.
  • If the packing process is interrupted before it is completed or fails to complete, the pack log remains in the text format.

Tree View Section

In the Tree View section, the Pack node is displayed as the Root node in a tree. This name of the node is the pack name you specified on the Folder Selection section.

Pack Node

The node contains the following folders:

  • Entities: contains the list of entities that are selected from the Entities tab.
  • Metadata: contains the list of metadata with their records that are selected from the Metadata tab.
  • Common: contains a list of metadata that is common among the entities and metadata.

The Tree View section also contains a Search field that can be used to search for any entity or metadata within tree.

Using Search Field to Find Addresses

 

Copyright © 2014-2017 Aptify - Confidential and Proprietary