 |
How do I layout a Text file, Database Query or View when building a Chart from my data source?
The recommended text file input type is a CSV (comma-delimited file).
The following OrgPublisher File Layout should be followed:
| Field | OrgPublisher Field |
Description |
| Field 1 | Parent Box ID | A required field, the parent box ID can be any string of numbers and/or characters that represent the report to box of this record. Each person or position in an org chart is represented by only one record in the Input File. However, a person may occupy more than one position in the chart and may appear in multiple input records. The parent box ID is not displayed in the chart. Only the top person in a chart will have an empty parent box ID. |
| Field 2 | Box ID | A required field, the box ID can be any string of numbers and/or characters that uniquely represent a box within the chart. This ID can be duplicated for several records when multiple people are located in the same box. The box ID is not displayed in the chart. You can add a unique box ID, typically an employee Id from your database. You can also use a position code if you use position management. Where the employee is placed in the chart depends on the Auto Build option, the position type priority, and the Sort option. Note: If you use the matrix reporting, or multi-relationship feature in OrgPublisher, the box ID for the person reporting to more than one person must be unique for each instance in the chart in order ensure correct drilling up through hierarchy. |
| Field 3 | Box Title | A required field, the box title can be any string of numbers and/or characters and is shown as the top text entry in the org chart box that it describes. This can be a cost center or full department name. The box title should be unique to the box ID that is also contained in this record. The same box title is displayed in every record that contains this box ID. |
| Field 4 | Record Type | A required field, record type defines the position type of each person in your organization. OrgPublisher provides several predefined records. You can also create custom record types to define other positions in your organization. Record types for custom position types should use brackets, < > (for example <T>). OrgPublisher's built-in record types are: M Manager E Employee A Assistant I Indirect Report (IM is an Indirect Report Manager) PR Partner C Contractor B Box (Note: You may not insert a person in a "B" record type. It is typically used to display org units or departments only.) SF Staff Function SC Succession Candidate If left blank, the record type defaults to an employee record type. |
| Field 5 | ID | The ID field is optional. It can contain any string of numbers or characters to represent the ID or unique identifier for a person, such as employee ID. With OrgPublisher version 5 and later this field is used to add a person to a group and to identify a person in order to add a multi-relationship icon. Therefore, the field is displayed and searchable by end users. Do not store sensitive information, such as a social security number, in this field. |
| Field 6 | Last Name | This is the last name of the employee. If fields 6, 7 and 8 are left blank, OrgPublisher will create an open position automatically. |
| Field 7 | First Name | The first name field represents the first name of the person that a record represents. |
| Field 8 | Middle Name | The Middle Name field represents the middle name of the person that a record represents. |
| Field 9 | Job ID | The job ID can be any string of numbers and/or characters that uniquely represent a job title or position title within the chart. If records are combined into one box, job titles are defaulted to list in ascending sequence by job ID and are sorted within each position type. The job ID is not displayed in the chart. This field is used in Auto Build. |
| Field 10 | Job Title | A required field, the job title can be any string of numbers and/or characters and is shown above the individual name within a box. A job title is associated with the first position type beneath the job title. The priority of the position type determines the order of job titles of different position types appearing within a box. You can override the priority by assigning the sequence number in field 13 of the comma-delimited text file. |
| Field 11 | Reserved (please leave blank) | Position 11 is reserved for use by OrgPublisher. To avoid problems when you are creating an org chart automatically from data, and to ensure compatibility with future versions of OrgPublisher, leave this field blank. |
| Field 12 | Box Sequence Number | Position 12 is the box sequence number and accepts only numeric (integer only) characters. It can be used, but is not required, to override the default positioning of the boxes. By default, boxes are positioned from left to right (level by level) in your chart alphabetically by box ID. This field is used when you select the Sort by box ID option of the OrgPublisher Sort feature. |
| Field 13 | Job Sequence Number | The job sequence number accepts only numeric (integer only) characters. It can be used, but is not required, to override the default positioning of the job title. By default, job IDs are used for sorting multiple jobs within a single box, such as people in the same box as their manager. |
| Field 14 | Position Sequence Number | The position sequence number can be used, but is not required, to override the default positioning of the employee name, and must be numeric (integer only) characters. By default, multiple employee names are sorted alphabetically within a single box. |
| Field 15 | Photo | The file names of the photos in your chart are stored in the photo field. Add photos with the Photo Wizard so that you can specify a common path for all of your photo files. If photos are stored in different areas you must put the full path name in this field. |
| Fields 16-17 | Reserved (please leave blank) | Positions 16 and 17 are reserved for use by OrgPublisher. To avoid problems when you are creating an org chart automatically from data and to ensure compatibility with future versions of OrgPublisher, leave these fields blank. |
| Field 18 | Level Number | Level number is used to pass in your levels for use in the multi-level peer display. This is a numeric absolute value level, for instance, if the manager grade level is 10 and the report-to is 1, OrgPublisher charts the report-to box as 9 levels below the manager box. The level number is a differential from the parent level number, either in ascending or descending order. The sequence cannot change in the middle of the “chain.” There are 10 levels to work with at each parent box level; any differential greater than 10 displays at the same level as 10. If there is no value in the parent box, it is assumed to be 0 (zero). . |
| Field 19 | Reserved | Position 19 is reserved for use by OrgPublisher. To avoid problems when you are creating an org chart automatically from data and to ensure compatibility with future versions of OrgPublisher, leave these fields blank. |
| Fields 20 - 25 | Custom Fields | Input fields in Positions 20 and up are for your custom fields, such as phone numbers, room numbers and hotspot URLs. After populating these fields in the Input File with your custom data, open the Custom Field Properties dialog and select where these fields should be displayed in your chart. A default label is supplied that you should type over. This example shows custom fields of hire date and phone number in Positions 20 and 21. If you plan to use the EChart security option, custom fields must be created to hold the unique identifiers for both the Password and User IDs. |
| Fields 26 - 49 | Custom Fields and Summary Fields | Positions 26 - 49 and 65+ can be used for custom fields, as well as summary fields. You can perform basic calculations on numeric custom fields in your chart and display this data in a summary field in your org chart. For example, you can calculate the total sales for a department and display that information in a summary field. The Summary Wizard and Head count Wizard automatically place summary fields in the Input File starting at Position 26. |
| Fields 50 - 64 | Succession Candidate Fields | Input fields in Positions 50 through 64 are standard fields provided for your succession candidates. After populating these fields in the Input File with your custom data, open the Custom Field Properties dialog and select where these fields should be displayed in your chart. Can be used to help define a successor group. 50 Key Person 51 Location 52 Age 53 Salary 54 Performance Rating 55 Education Level 56 Skills 57 Certifications 58 Competency Rating 59 Successor Rank 60 Designated Successor 61 High Potential Rating 62 Readiness 63 Retention Risk 64 Impact of Loss |
| Fields 65 and up | Custom Fields and Summary Fields | Positions 65 and up can be used for custom fields, as well as summary fields. You can perform basic calculations on numeric custom fields in your chart and display this data in a summary field in your org chart. Note: In OrgPublisher Enterprise, the Summary Wizard inserts placeholders, if necessary, which display in the Custom Field Properties dialog. These fields within OrgPublisher, occupy sequences 20 - 25, and are designated as field types other than summaries, such as Text, Hotspot or Email. As you create summary fields, OrgPublisher starts placing them in sequence 26. When importing numeric fields, make sure that you do not use any leading symbols, such as dollar signs. Also, verify that decimal places are set the way you want them prior to importing those fields into OrgPublisher. You can add leading and trailing symbols to numeric fields with the Field Format dialog, but the decimal places cannot be adjusted after they are imported. OrgPublisher does not change the value of numeric fields you bring in. For instance, if you import 341.00, that's what the number is in OrgPublisher. If you import 341, that's what OrgPublisher uses. Formatting cannot change the value of the data you import. |
If you are creating a specific database Table or View, your fields should reflect the same above Fields. You will then use the ODBC Connection type when creating your new Chart .
Related Topics
Input File LayoutAutomation Tools/SDK
Automatic Building Charts
