Understanding Aptify Administration

This topic is composed of the following sub-topics that contain reference information related to the administration of the Aptify environment:

• About the Administrative Services
• Understanding the IT Developer and Database Admin Role-based Profile
• About the Administration Application Forms

About the Administrative Services

This list displays the services covered in this topic as well as the application in which they are located. The applications listed are the default locations for the services. If the service is not available on your system, in the listed application, please contact your system administrator. A complete listing of services and applications is located in the About the Applications and their Services and About the Services and their Applications.

Note that information on services related to addresses and phone numbers can be found in About the Customer and Member Management Services.

See Administering Entities and About the Administration Application Forms for information about the standard forms for the services listed below.

Service	Application(s)
Alert Types	Aptify Framework Administration
Application Entities	Aptify Framework Administration
Application User Entities	Aptify Framework Administration
Application Users	Aptify Framework Administration
Applications	Aptify Framework Administration
Archive Runs	Aptify Framework Administration
Archive Types	Aptify Framework Administration
Attachment Categories	Aptify Framework Administration
Attachments	Aptify Framework Administration
Base Fields	Aptify Framework Administration
Calendar Views	Aptify Framework Administration
Chart View Types	Aptify Framework Administration
Chart Views	Aptify Framework Administration
Config Packages	Aptify Framework Administration
Countries	Aptify Framework Administration Localization Administration
Culture String Categories	Localization Administration
Culture Strings	Localization Administration
Cultures	Localization Administration
Dashboard Areas	Aptify Framework Administration
Dashboard Button Bars	Aptify Framework Administration
Dashboard Buttons	Aptify Framework Administration
Dashboard Component Categories	Aptify Framework Administration
Dashboard Components	Aptify Framework Administration
Dashboard Parts	Aptify Framework Administration
Dashboards	Aptify Framework Administration
Database Objects	Aptify Framework Administration
Entities	Aptify Framework Administration
Entity Bulk Operations	Aptify Framework Administration
Entity Most Recently Used List	Aptify Framework Administration
Entity Record Template Categories	Aptify Framework Administration
Entity Record Template User -Preferences	Aptify Framework Administration
Entity Record Templates	Aptify Framework Administration
Entity View Types	Aptify Framework Administration
Filter Rule Operators	Aptify Framework Administration
Filter Rule Types	Aptify Framework Administration
Filter Rules	Aptify Framework Administration
Form Component Categories	Aptify Framework Administration
Form Components	Aptify Framework Administration
Form Template Part Categories	Aptify Framework Administration
Form Template Parts	Aptify Framework Administration
Form Templates	Aptify Framework Administration
Import Run Details	Aptify Framework Administration
Import Runs	Aptify Framework Administration
Import Source Types	Aptify Framework Administration
Import Sources	Aptify Framework Administration
Gantt Views	Aptify Framework Administration
Groups	Users Administration
Licenses	Aptify Framework Administration
List Types	Aptify Framework Administration
Lists	Aptify Framework Administration
Map Views	Aptify Framework Administration
Message Actions	Aptify Framework Administration Messaging Administration
Message Part Categories	Aptify Framework Administration Messaging Administration
Message Parts	Aptify Framework Administration Messaging Administration
Message Run Overrides	Aptify Framework Administration Messaging Administration
Message Runs	Aptify Framework Administration Messaging Administration
Message Sources	Aptify Framework Administration Messaging Administration
Message Schedule Categories	Aptify Framework Administration Messaging Administration
Message Schedule Logs	Aptify Framework Administration Messaging Administration
Message Schedule	Aptify Framework Administration Messaging Administration
Message Systems	Aptify Framework Administration Messaging Administration
Message Template Categories	Aptify Framework Administration Messaging Administration
Message Templates	Aptify Framework Administration Messaging Administration
Message User Profile	Aptify Framework Administration Messaging Administration
Object Access Methods	Object Repository Administration
Object Contexts	Object Repository Administration
Object Packages	Object Repository Administration
Object Repository Classes	Object Repository Administration
Object Repository Objects	Object Repository Administration
Object Types	Object Repository Administration
Pending Changes	Aptify Framework Administration
Prefix	Aptify Framework Administration
Report Categories	Aptify Framework Administration
Script Languages	Aptify Framework Administration
Script Types	Aptify Framework Administration
Security Keys	Aptify Framework Administration
Shortcut Sections	Users Administration
Shortcuts	Users Administration
Suffix	Aptify Framework Administration
User License Assignment	Aptify Framework Administration
User Values	Users Administration
Users	Users Administration
View Categories	Aptify Framework Administration
View Types	Aptify Framework Administration
Views	Aptify Framework Administration
Wizards	Aptify Framework Administration
Word Template Categories	Aptify Framework Administration
Word Templates	Aptify Framework Administration

Understanding the IT Developer and Database Admin Role-based Profile

Aptify includes several pre-defined role-based profiles that can simplify a particular type of user's interaction with the system. Aptify has designed one of these profiles based on the typical requirements of an organization's database developers and administrators. This profile, known as the IT Developer profile, provides easy access to the information and functions within Aptify commonly accessed by an individual who is responsible for developing and/or maintain the Aptify system.

A role-based profile is intended as a starting point for a particular type of Aptify user. As applicable, an administrator can leverage the profiles provided by Aptify to create new profiles specific to an organization. Also, once an end user's Aptify profile has been created, he or she can modify the profile as needed to personalize the Aptify user experience.

See About Role-based Profiles for more information on role-based profiles.

This topic describes the design and layout of the Developer/Database Admin profile included with Aptify. It covers the following sub-topics:

• About the IT Developer User Main Dashboard
• About the IT Developer Shortcuts
• About the IT Developer Subscribed Applications

About the IT Developer User Main Dashboard

The main dashboard for the Developer/Database Admin profile includes the following elements:

• IT Developer Button Bar: The top of the Developer/Database Admin's main dashboard contains a button bar with the following buttons:
  • New User: Click this button to launch the Aptify User Administration wizard. See Creating User Accounts for more information about creating users in Aptify.
  • New Process Flow: Click this button to open a new Process Flow record.
  • New Wizard: Click this button to open a new Wizards record.
  • New Entity Bulk Operation: Click this button to open a new Entity Bulk Operations record.
  • New Entity: Click this button to open a new Entities record.
     
• Most Recently Used Record: This instance of the Most Recently Used control provides quick access to recently viewed records and views for the current user.See  Using the Desktop Client Most Recently Used Dashboard for details.
  • Note that the items that appear in the dashboard list are limited to those records whose entities support the Most Recently Used Records component. See Enabling Support for Most Commonly Used Records for more details.
     
• My Open Task: This is a list view that displays incomplete tasks that are assigned to the current user's Employees record (that is assigned tasks that are less than 100 percent complete). This view includes a hierarchy that displays information for existing tasks that need to be completed before this task can be started.
• Groups: This is a list view that displays the Groups within the Aptify system. This view contains a hierarchy that displays a list of users in a particular group.
• Most Used Entities: This is a chart view of Most Recently Used system data that provides insight into the most commonly accessed entities within Aptify. Note that only entities that support the Most Recently Used Records component are eligible to appear in this chart. Also, this view filters out the Views entity for a better representation of entity use.
  
   

About the IT Developer Shortcuts

The Developer/Database Admin User profile includes a set of shortcuts that provide instant access to information in Aptify that is of interest to members of an organization's IT department. The shortcuts appear in two groups:

• General Shortcuts
• Views Shortcuts

General Shortcuts

• Find Process Flow By Name: A prompt view to locate a Process Flow based on its name.
• Find Entity By Name: A prompt view to locate an Entity based on its name.
• Find DB Object By Name: A prompt view to locate a Database Object based on its name.
• Find A User By Name: A prompt view to locate a user in the Aptify system by User ID.

Views Shortcuts

• Find Application By Entity Name: A prompt view to locate an Application based on an entity within a particular application. This view contains hierarchies that display information about the user and group permissions for the application as well as information about all entities associated with a particular application.
• Find Object Repository Objects By Local Name: A prompt view to locate an Object Repository Object by its Local Name. This view contains a hierarchy that displays information about the Object Repository Classes associated with a particular object.
• All Active Users: This is a list view of all Users with a Status of Active in the Aptify system. 
• Top Level Business Applications Entities: This is a list view of all top-level business entities within the Aptify database. This view contains hierarchies that display information about the fields, reports, user and group permissions and the related sub-type entities for a particular top-level entity.  
  
  

About the IT Developer Subscribed Applications

The Developer/Database Admin User profile is subscribed to the Development, Framework, Object Repository, Process Pipeline, and User Administration applications by default. Each application has its own dashboard that provides access to information that is important to database development and administration staff.

This topic contains the following sub-topics:

• About the IT Developer Development Application
• About the IT Developer Framework Application
• About the IT Developer Object Repository Application
• About the IT Developer Process Pipeline Application
• About the IT Developer User Administration Application

About the IT Developer Development Application

The Developer/Database Admin user subscribes to the Applications, Database Objects, Entities, Entity Bulk Operations, Process Flows, Views and Wizards services by default in the Development application. Note that a user can add or remove services as necessary using the Application Services dialog. (See Using Applications and Services for details.)

The dashboard for the Development application includes the following elements from top to bottom:

• Dashboard Button Bar: The top of the Developer/Database Admin's Development dashboard contains a button bar with the following buttons:
  • New User: Click this button to open a new Persons record.
  • New Process Flow: Click this button to open a new Process Flow record.
  • New Wizard: Click this button to open a new Wizards record.
  • New Entity Bulk Operation: Click this button to open a new Entity Bulk Operations record. 
  • New Entity: Click this button to open a new Entities record.
     
• Applications: This is a list view of all applications within the Aptify system. This view contains hierarchies that displays information about the user and group permissions for the application as well as information about all entities associated with a particular application.
• Entities: This is a list view of all entities within the Aptify database. This view contains hierarchies that display information about the fields, user and group permissions and the related sub-type entities for a particular top-level entity.  
  
  

About the IT Developer Framework Application

The Developer/Database Admin user subscribes to the Archive Runs, Base Fields, Dashboards, Entity Record Templates, Form Templates, Import Runs, Message Parts, Message Templates, Pending Changes, Security Key and Word Templates services by default in the Framework application. Note that a user can add or remove services as necessary using the Application Services dialog. (See Using Applications and Services for details.)

The dashboard for the Framework application includes the following elements from top to bottom:

• Upcoming Pending Changes: This is a list view that displays Pending Changes that are scheduled to be applied to records in the future. This view contains a hierarchy that displays the pending changes detail for the particular change. Note that this view is collapsed by default, but a user can expand, and collapse dashboard parts as needed using the caption button (click the plus sign to expand and the minus sign to collapse).
• Top Level Form Templates: This is a list view of all top-level Form Templates within the Aptify database. This view contains a hierarchy that displays information about the Form Templates Parts associated with a particular template.
• Dashboard (Most Recent First): This is a list view of all Dashboards records within the Aptify system in descending order by ID. This view contains a hierarchy that displays information about the Dashboard Areas associated with a particular dashboard.
  
   

About the IT Developer Object Repository Application

The Developer/Database Admin user subscribes to the Object Access Methods, Object Contexts, Object Packages, Object Repository Classes, Object Repository Objects and Object Types services by default in the Object Repository application. Note that a user can add or remove services as necessary using the Application Services dialog. (See Using Applications and Services for details.)

The dashboard for the Object Repository application is the standard dashboard provided by Aptify to manage the Object Repository. See Using the Object Repository Dashboard for details.

About the IT Developer Process Pipeline Application

The Developer/Database Admin user subscribes to the Application Servers, Event Definitions, Event Handlers, Process Flow Runs, Process Flow Steps, Process Flows, Scheduled Task Services and Scheduled Tasks services by default in the Process Pipeline application. Note that a user can add or remove services as necessary using the Application Services dialog. (See Using Applications and Services for details.)

The dashboard for the Process Pipeline application includes the following elements from top to bottom:

• All Process Flows: This is a list view of all process flows.
• All Scheduled Tasks: This is a list view of all scheduled tasks.
• All Event Handlers: This is the Aptify Event Handle Management Dashboard component which is a summary of all Event Handlers records defined for a specific event or application. See Setting Up Event Handlers for more details. 
  
  

About the IT Developer User Administration Application

The Developer/Database Admin user subscribe to the Groups, Licenses and Users services by default in the User Administration application. Note that a user can add or remove services as necessary using the Application Services dialog. (See Using Applications and Services for details.)

The dashboard for the User Administration application includes the following elements from left to right:

• All Groups: This is a list view of all groups in the Aptify database.
• Assigned Licenses: This is a list view of all licenses that are currently assigned to users of the Aptify system.
• All Users: This is a list view of all users in the Aptify database. Selecting a new record from this view launches the User Administration wizard. See Creating User Accounts for more information about creating users in Aptify.
• Unassigned Licenses: This is a list view of all licenses that are currently unassigned in the Aptify system.
  
   

About the Administration Application Forms

This topic provides field-by-field information on every form used in or during the configuration of administration services and includes all services found in the Aptify Framework Administration, Localization, Object Repository Administration, and User Administration applications. This topic is intended for use as a reference for the various fields on these forms.

This topic documents the forms in alphabetical order. Within each form, tabs are also addressed in alphabetical order.

Note that the fields marked as required in this topic are required at the entity level. In some cases, a required field may already have a default value, so a user does not need to specify a value for these fields before saving the record. To review the list of fields required at the entity level, open the appropriate Service Properties dialog (by right clicking the service in the Navigation Bar and selecting Properties) and click the Fields tab.

The following forms are documented in this topic:

• About the Alert Types Form
• About the Application Entities Form
• About the Application Ribbon Group Buttons Form
• About the Application Ribbon Groups Form
• About the Applications Form
• About the Applications Ribbons Form
• About the Application User Entities Form
• About the Application Users Form
• About the Archive Runs Form
• About the Archive Types Form
• About the Attachment Categories Form
• About the Attachments Form
• About the Base Fields Form
• About the Calendar Views Form
• About the Chart View Types Form
• About the Chart Views Form
• About the Command Categories Form
• About the Commands Form
• About the Continents Form
• About the Countries Form
• About the Culture String Categories Form
• About the Culture Strings Form
• About the Cultures Form
• About the Dashboard Areas Form
• About the Dashboard Button Bars Form
• About the Dashboard Buttons Form
• About the Dashboard Components Categories Form
• About the Dashboard Components Form
• About the Dashboard Parts Form
• About the Dashboards Form
• About the Database Objects Form
• About the Entity Bulk Operations Form
• About the Entity Bulk Operations Group Permissions Form
• About the Entity Bulk Operations Rules Form
• About the Entity Bulk Operations User Permissions Form
• About the Entity Most Recently Used List Form
• About the Entity Record Template Categories Form
• About the Entity Record Template User Preferences Form
• About the Entity Record Templates Form
• About the Entity View Types Form
• About the Error Log Form
• About the Filter Rule Items Form
• About the Filter Rule Operators Form
• About the Filter Rule Type Entity Instances Form
• About the Filter Rule Types Form
• About the Filter Rules Form
• About the Form Component Categories Form
• About the Form Components Form
• About the Form Template Part Categories Form
• About the Form Template Parts Form
• About the Form Template Permissions Form
• About the Form Templates Form
• About the Full Text Catalogs Form
• About the Full Text Indexes Form
• About the Gantt Views Form
• About the Group Members Form
• About the Group Permissions Form
• About the Groups Form
• About the Import Run Detail Columns Form
• About the Import Run Detail Match Records Form
• About the Import Run Details Form
• About the Import Run Mappings Form
• About the Import Runs Form
• About the Import Source Columns Form
• About the Import Source Types Form
• About the Import Sources Form
• About the Input Properties Form
• About the Licenses Form
• About the List Types Form
• About the Lists Form
• About the Local Strings Form
• About the Map View Data Set Field Map Form
• About the Map View Data Sets Form
• About the Map Views Form
• About the Message Actions Form
• About the Message Action Entities Form
• About the Message Attributes Form
• About the Message Part Categories Form
• About the Message Parts Form
• About the Message Permissions Form
• About the Message Run Overrides Form
• About the Message Runs Form
• About the Message Schedule Categories Form
• About the Message Schedule Logs Form
• About the Message Schedule Templates Form
• About the Message Schedules Form
• About the Message Sources Form
• About the Message Systems Form
• About the Message Template Categories Form
• About the Message Templates Form
• About the Message User Profiles Form
• About the Messaging Fields Form
• About the Object Access Methods Form
• About the Object Contexts Form
• About the Object Packages Form
• About the Object Repository Classes Form
• About the Object Repository Objects Form
• About the Object Repository Related Objects Form
• About the Object Types Form
• About the Parts Link Form
• About the Pending Changes Form
• About the Pivot Table Views Form
• About the Possible Values Form
• About the Report Categories Form
• About the Script Languages Form
• About the Script Type Available Objects Form
• About the Script Type GAC References Form
• About the Script Type Languages Form
• About the Script Type Repository References Form
• About the Script Types Form
• About the Scripts Form
• About the Security Keys Form
• About the Shortcut Sections Form
• About the Shortcuts Form
• About the Spelling Systems Form
• About the User License Assignment Form
• About the User Permissions Form
• About the User Values Form
• About the Users Form
• About the Versions Form
• About the View Categories Form
• About the View Types Form
• About the Views Form
• About the Wizard Page Process Flows Form
• About the Wizard Pages Form
• About the Wizards Form
• About the Word Template Categories Form
• About the Word Templates Form

The following services appear in the Aptify Framework Administration application but are described in another topic. See the topics specified below for information on the following services in the Aptify Framework Administration application:

• Address Types: See About the Address Types Form.
• Address Verification Run Details: See About the Address Verification Run Details Form.
• Address Verification Runs: See About the Address Verification Runs Form.
• Address Verification Systems: See About the Address Verification Systems Form.
• Addresses: See About the Addresses Form.
• Entities: See About the Entities Form.
• Event Categories: See About the Event Categories Form.
• Event Definitions: See About the Event Definitions Form.
• Event Handlers: See About the Event Handler Form.
• Phone Numbers: See About the Phone Numbers Form.
• Postal Codes: See About the Postal Codes Form.
• Process Components: See About the Process Components Form.
• Process Flow Categories: See About the Process Flow Categories Form.
• Process Flow Steps: See About the Process Flow Steps Form.
• Process Flows: See About the Process Flows Form.
• States And Provinces: See About the States And Provinces Form.
• Topic Code Links: See About the Topic Code Links Form.
• Topic Codes: See About the Topic Codes Form.