Working with attributes

An attribute is data used to describe the characteristics of an object in the application. For example, SGPCompanyName is an attribute representing the name of your company, and its value is your company name.

You can filter a list of symbols based on their attribute values in a Model or Dataspec Document. You can filter symbols in several ways, depending on whether you want root symbols, leaf symbols, descendants, and so on.

This chapter contains information on these main topics:

• “Understanding attribute classes”
• “Understanding attribute types”
• “Working with attribute commands and functions”
• Working with Symbol attributes
• “Understanding attribute names and parameters”
• “Working with preconfigured System attributes”
• “Creating and modifying attributes”

Understanding attribute classes

There are several attribute classes:

Understanding attribute types

For each attribute class, an attribute describes some aspect of it. When these attributes are created, you must specify what type of data values may be specified for them.

Working with attribute commands and functions

To work with attributes in Application Framework, you need to understand how to use the following commands:

• Append Attribute
• Create Attribute
• Delete Attribute
• Refresh Attribute
• Set Attribute

You also need to understand how to use the following functions:

• AttributeExists
• AttributeFilter
• CreateList

For more information, see the Longview Developer’s Guide.

Working with Symbol attributes

Symbol attributes (prefixed with Z) are attributes that specify characteristics of individual symbols. You can set values for these attributes to configure symbols in your Longview system.

Understanding attribute names and parameters

The following tables contain lists of attribute names and default parameters, classified by type (SYSTEM, USER, or SYMBOL).

For more information on lists of attribute names and default parameters, see

• System attribute names and parameters
• User attribute names and parameters
• Symbol attribute names and parameters

System attribute names and parameters

Note: A value of SGPDecimalsZero is only meaningful if it is less than the value of SGPDecimals / SGPDecimalsLeaf / SGPDecimalsSubmissions.

User attribute names and parameters

Symbol attribute names and parameters

Working with preconfigured System attributes

System attributes (prefixed with S) are preconfigured attributes that specify systemwide characteristics. You can set values for these attributes to configure various functionalities and settings in your Longview system.

This section contains information on these topics:

• Specifying the symbols displayed in the Events Status tool
• Specifying duplicate data handling for submissions
• Specifying System attributes for Longview Workflow

Specifying the symbols displayed in the Events Status tool

The SDataAreaStatusHierarchies System attribute specifies the list of symbols displayed in the drop-down list and Symbol Selector in the Events Status tool.

If no value is set for this attribute, all root symbols, and all levels of symbols below them in the data area status dimension are displayed the drop-down list and Symbol Selector in the Events Status tool.

To specify the symbols displayed in the Events Status tool:

1. In the Server Explorer pane, expand Attributes and select SYSTEM.
2. In the Contents window, right-click SDataAreaStatusHierarchies, and select Set Value. The Attribute Values dialog opens.
3. In the Values area, enter the symbol specification for the symbol or symbols to display in the Events Status tool in Enter New Value.

For each symbol specification, specify a symbol name and the level of symbols below that symbol in the hierarchy to display.

You can use the following symbol specifications:

Note: The specified symbols must be in the dimension specified for the Data Area Status Dimension parameter in Longview Server Manager. For more information, see the Longview Server Manager Guide.

The current list of symbol specifications for SDataAreaStatusHierarchies displays in Value List.

1. In the Values area, click Add to list.
2. Repeat step 3 and step 4 for each symbol specification that you want to include in the symbol list.
3. When you are finished adding symbol specifications, click Apply.
4. Click OK.

Specifying duplicate data handling for submissions

The SGPSubmissionRules System attribute specifies how duplicate data is handled for submissions for cells calculated by a model rule.

To specify duplicate data handling for submissions:

1. In the Server Explorer pane, expand Attributes and select SYSTEM.
2. In the Contents window, right-click SGPSubmissionRules, and select Set Value. The Attribute Values dialog opens.
3. In the Values area, specify a value for SGPSubmissionRules in Enter New Value. The current value for SGPSubmissionRules displays in Value.

   Possible values for SGPSubmissionRules include the following:

   Value	Description
   OFF	Duplicates are submitted. This is the default value.
   FILTER	Non-duplicates are submitted. Duplicates are listed in a server output temp file named username_sessionID_Duplicate.tmp.

   Note: For journal entries, the duplicate coordinate check is performed during validation, and therefore the system attribute for FILTER is handled in the same way as ERROR. The JE validation will fail, and the user will see an error message.

4. In the Values area, click Assign to value.
5. Click Apply.
6. Click OK.

Specifying System attributes for Longview Workflow

The following System attributes configure various functionalities and settings in Longview Workflow.

Specifying certification for approval processes

The SWFUseCertification System attribute specifies whether certification is available for approval processes in Longview Workflow. For more information see the Workflow Designer Guide.

To specify certification for approval processes:

1. In the Server Explorer pane, expand Attributes and select SYSTEM. 
2. In the Contents window, right-click SWFUseCertification, and select Set Value. The Attribute Values dialog opens.
3. In the Values area, specify a value for SWFUseCertification in Enter New Value. The current value for SWFUseCertification displays in Value.

   Possible values for SWFUseCertification include the following:

   Value	Description
   TRUE	Certification is available for approval processes in Longview Workflow. If this attribute is set to TRUE, the Certify data field displays in the Approval Process wizard in Longview Workflow Designer. If Certify data is selected, certification definitions can be added to approval processes. When users work with an approval process that has a certification definition in Longview Workflow on the web, they can certify data in that approval process.
   FALSE	Certification is unavailable for approval processes in Longview Workflow. If this attribute is set to FALSE, the Certify data field does not display in the Approval Process wizard in Longview Workflow Designer. Certification definitions cannot be added to approval processes. This is the default value.

4. In the Values area, click Assign to value.
5. Click Apply.
6. Click OK.

Specifying visibility for DataAreas outside of approval processes

The SWFUseGlobalVisibility System attribute specifies whether DataAreas outside of the DataAreas specified for all approval process are visible to users.

Note: This attribute applies only if SWFUseVisibility is set to TRUE. For more information, see “Specifying data visibility options for approval processes”.

To specify visibility for DataAreas outside of approval processes:

1. In the Server Explorer pane, expand Attributes and select SYSTEM.
2. In the Contents window, right-click SWFUseGlobalVisibility, and select Set Value. The Attribute Values dialog opens.
3. In the Values area, specify a value for SWFUseGlobalVisibility in Enter New Value. The current value for SWFUseGlobalVisibility displays in Value.

   Possible values for SWFUseGlobalVisibility include the following:

   Value	Description
   TRUE	All DataAreas outside of the DataAreas specified for all approval processes are visible to users. This is the default value.
   FALSE	All DataAreas outside of the DataAreas specified for all approval processes are not visible to users.

4. In the Values area, click Assign to value.
5. Click Apply.
6. Click OK.

Specifying parent symbol visibility in the time periods dimension

The SWFUseTimePeriodVisibility System attribute specifies whether the visibility settings of DataAreas for parent symbols in the time periods dimension (as specified by the SGPTimePeriods System attribute) are affected when the DataAreas for leaf symbols in the time periods dimension are set to invisible, for all approval processes.

Note: This attribute applies only if SWFUseVisibility is set to TRUE. For more information, see “Specifying data visibility options for approval processes”.

To specify parent symbol visibility in the time periods dimension:

1. In the Server Explorer pane, expand Attributes and select SYSTEM.
2. In the Contents window, right-click SWFUseTimePeriodVisibility, and select Set Value. The Attribute Values dialog opens.
3. In the Values area, specify a value for SWFUseTimePeriodVisibility in Enter New Value. The current value for SWFUseTimePeriodVisibility displays in Value.

   Possible values for SWFUseTimePeriodVisibility include the following:

   Value	Description
   TRUE	When the DataAreas for leaf symbols in the time periods dimension are set to invisible, DataAreas for parent symbols in the time periods dimension are also set to invisible.
   FALSE	When the DataAreas for leaf symbols in the time periods dimension are set to invisible, the visibility of the DataAreas for parent symbols in the time periods dimension is unaffected. This is the default value.

4. In the Values area, click Assign to value.
5. Click Apply.
6. Click OK.

Specifying data visibility options for approval processes

The SWFUseVisibility System attribute specifies whether data visibility options are available for approval processes in Longview Workflow.

To specify data visibility options:

1. In the Server Explorer pane, expand Attributes and select SYSTEM.
2. In the Contents window, right-click SWFUseVisibility, and select Set Value. The Attribute Values dialog opens.
3. In the Values area, specify a value for SWFUseVisibility in Enter New Value. The current value for SWFUseVisibility displays in Value.

   Possible values for SWFUseVisibility include the following:

   Value	Description
   TRUE	Data visibility options are available for approval processes in Longview Workflow. If this attribute is set to TRUE, the Visible field displays in the Approval Process wizard in Longview Workflow Designer. Owners and Approvers can modify data visibility when working with approval processes in Longview Workflow on the web.
   FALSE	Data visibility options are not available for approval processes in Longview Workflow. If this attribute is set to FALSE, the Visible field does not display in the Approval Process wizard in Longview Workflow Designer. Owners and Approvers cannot modify data visibility when working with approval processes. This is the default value.

4. In the Values area, click Assign to value.
5. Click Apply.
6. Click OK.

Creating and modifying attributes

While the application has many preconfigured attributes, you may want to create new attributes of your own. You may also want to set the value of an attribute for a given symbol. This section explains how to perform these tasks.

Naming attributes

When you are creating attributes, you should consider certain naming conventions. At first glance, an attribute name seems rather odd. In fact, however, the name is created to provide maximum information about its purpose. For example, the SGPTimePerYTD attribute is a general SYSTEM attribute whose purpose is to identify time period symbols containing year-to-date data values.

To create a valid attribute name, follow these guidelines:

• Attribute names can contain only letters or numbers; they cannot contain spaces, punctuation, or other special characters.
• Attribute names contain a maximum of 31 characters, consisting of the following parts:

  Part	Possible values	Description
  First character	A—Application-specific attribute, second character defines type S—Core system attribute U—Core user attribute Z—Core symbol attribute	Identifies the basic attribute category.
  Second character (for application-specific attributes)	S—SYSTEM attribute U—USER attribute Z—SYMBOL attribute	Identifies the attribute class.
  Remainder	For example: GPAccountDim—Name of the dimension that contains account symbols ElimAcctInv—List of investment accounts for intercompany eliminations	Provides a description of the purpose of the attribute.

Creating attributes

You can create an attribute in two ways: from the file menu, or by duplicating an existing attribute.

To create an attribute, follow these steps:

1. Open Longview Application Administrator.
2. Select File > New > Attribute. The New Attribute Definition dialog opens.
3. If necessary, select the attribute’s class from the drop-down list.
4. Enter a name for your attribute, following the conventions outlined in “Naming attributes”.

   

5. Enter a description for the attribute.
6. Use the radio buttons to designate if the attribute will accept a single value (Single), or a list of values (List).
7. Select the attribute type from the drop-down list.
8. If you selected User as the attribute type, use the Access drop-down list to designate if the attribute may be written to, or is to be read-only.
9. If necessary, enter the default value for the attribute.
10. Click OK. The new attribute appears in the list of attributes.

Duplicating attributes

To duplicate an attribute, follow these steps:

1. Open Longview Application Administrator.
2. In the Server Explorer pane, expand Attributes and select the attribute class containing the attribute you want to duplicate. A list of all the attributes for the selected class appears in the Contents window.
3. Right-click the attribute you want to duplicate and select Duplicate.
4. Enter a name for the new attribute.
5. Enter a description for the new attribute.
6. If necessary, provide a default value for the attribute.
7. Click OK. The new attribute appears in the list of attributes.

Modifying attributes

Note: You can modify attributes that have been created by users in your system only. It is not possible to modify core attributes.

To modify an attribute, follow these steps:

1. Open Longview Application Administrator.
2. In the Server Explorer pane, expand Attributes and select the attribute class containing the attribute you want to modify. A list of all the attributes for the selected class appears in the Contents window.
3. Right-click the attribute you want to change and select Properties.
4. Edit the properties of the attribute as required.

   Note: You can modify an attribute’s Name, Description, and Default value only.

5. Click OK. Your changes are saved.

Setting attribute values

To set the value of an attribute, follow these steps:

1. Open Longview Application Administrator.
2. In the Server Explorer pane, expand Attributes and select the attribute class containing the attribute for which you want to set the value(s). A list of all the attributes for the selected class appears in the Contents window.
3. Right-click the attribute and select Set Value. The Attribute Values dialog opens.

   

4. Use Object Selection buttons to organize and find objects. The objects displayed are dependent on the attribute class. By default, the objects are arranged in tree hierarchies, if the attribute class is SYMBOL.
   • To arrange them by name regardless of their place in the hierarchy, click the List View icon.
   • To search for an object, click the Search button and enter search strings in the Name and/or Description fields.
5. Select the type/Dimension that has the object or objects for which you want to set the value of the attribute.
6. Select the appropriate check box for the objects that contain the attributes you want to set the values for.
7. In the Values area, enter the value for the attribute for this object. Depending on the attribute type, additional options may be available as follows:
   • Symbol, SymbolList—Click the symbol selector ( ... ) button to bring up the symbol selector.
   • Date, DateList—Click the combo box drop arrow to bring up the date selector.
8. Click Assign to value.
   • Some attributes can assign a list of values. If this is the case with your attribute, you will see a list box accompanied by three buttons (the up arrow, down arrow, and X). Enter as many values as you need. You can order the list of values by selecting a value and clicking the up arrow to move it up in the list, and the down arrow to move it down. Clicking X deletes the selected value.
9. When you have finished assigning the value or values, click Apply.
10. Click OK.

Deleting attributes

Note: You can delete attributes that have been created by users in your system only. It is not possible to delete core attributes.

To delete an attribute, follow these steps:

1. Open Longview Application Administrator.
2. In the Server Explorer pane, expand Attributes and select the attribute class containing the attribute you want to delete. A list for all the attributes for the selected class appears in the Contents window.
3. Right-click the attribute you want to delete and select Delete. A confirmation dialog appears.

   Caution: If you delete an attribute, it cannot be recovered. To restore a deleted attribute to the system, it must be recreated. Use this function with caution.

4. Click Yes. The attribute is deleted.