This section contains information to assist users in building action log scripts that can be executed either by the Framework Manager (FM) Software Developer Kit (SDK) or directly in Framework Manager. Action log files do not conform directly to this specification (mdActions.xsd). There is, however, a direct one-to-one mapping between the parameter lists in this specification and the parameters as found in the action logs. The mapping is handled by the type specified for a parameter. The set of defined types described at the end of this section (see the heading entitled Types) describes the valid types and the parameters to which they map in the action logs. Note: Sample action log entries are provided for many of the actions in this section. They illustrate the proper encoding for the action logs. Every action element is encoded in the action logs as an action and its type attribute is set to the name of the element. For example, the element AddLocale is encoded as an action element in the action logs, with its type attribute set to AddLocale. For an example of this encoding, see the Sample action log entry for the AddLocale element. Note: The action element is documented in the Metadata Provider (Wrapper) Reference. If the value is an XML fragment, new child properties are created under the property in question from the child elements or attributes that exist in this value. For example, in the following value being set on an instance of an existing package/functionSets property: <functionSet><functionSetID>V_DB2</functionSetID> </functionSet> <functionSet><functionSetID>V_MSAccess</functionSetID></functionSet> <functionSet><functionSetID>V_Oracle</functionSetID></functionSet> Three instances of functionSetID child properties will be created under the functionSets property, and their values set to V_DB2, V_MSAccess, and V_Oracle, respectively. This type of value applies to a complex property. A complex property is one that can contain child properties of its own. In general, when dealing with a property that can have children, specify this option. Note: All reserved XML characters must be escaped, even if the value is specified as an XML fragment. For more information, see the Framework Manager model schema. Represents a path to a text file containing multiple columns of data, each column separated by a fixed delimiter character. If the extension specified for the file is .csv, the delimiter is assumed to be a comma and the file is assumed to be in comma-separated values format and encoded according to the ISO 8859-1 (Latin-1) standard. Otherwise, the delimiter is assumed to be the tab character and the file is assumed to be in tab-delimited format, encoded according to the ISO 10646 UTF-8 (Unicode) standard. Note: Path separator is "\" for Windows, "/" for UNIX. Maps to a parameter of type stringCollection in the action logs. Encoded in the same way as stringCollection, but the value for every item must be a valid XML language code. For example, a parameter containing the languages English, German and French (Canada) would be encoded as: <stringCollection><item>en</item><item>de</item><item>fr-ca</item></stringCollection> Maps to a parameter of type cclnode in the action logs. Encoded as an XML fragment contained within a CDATA element. For example: ![CDATA[<setObjectAccess><object rule="include" refobj="[1 - GOSales - OLE-DB].[CONVERSIONRATE]"><access type="group" displayPath="All Authenticated Users [Directory > Cognos]" cmSearchPath="CAMID("::All Authenticated Users")"/><access type="role" displayPath="Authors [Directory > Cognos]" cmSearchPath="CAMID(":Authors")"/></object></setObjectAccess>]] Maps to a parameter of type handle in the action logs. Refers to an object in the model, encoded in the same manner as a standard object reference in the model. An object reference is a concatenation of object names from an object to the nearest ancestor namespace. For example, [gosales_ml].[CONVERSION_RATE].[COUNTRY_CODE] - the query item COUNTRY_CODE which is contained in query subject CONVERSION_RATE, which in turn is contained in namespace gosales_m. Maps to a parameter of type i18nstring in the action logs. The object name follows similar constraints to that of W3C NMTOKEN: Cannot be blank. If specified, an exception is thrown. Cannot have either leading or trailing whitespace. If specified, the leading and trailing whitespace is implicitly trimmed from the name. Cannot have consecutive blanks. If specified, any such occurrence is implicitly truncated to a single blank. For example, an object name of " My Object " is implicitly truncated by Framework Manager to "My Object". Maps to a parameter of type i18nstring in the action logs. Essentially the same as objectHandle, but is slightly different with respect to how it is handled internally. Maps to a parameter of type stringCollection in the action logs. Encoded the same as stringCollection, but the value for every item must be a valid ISO-639 language code. Maps to a parameter of type handle in the action logs. Refers to a property in the model, encoded as the same as an object reference is encoded in Framework Manager to identify the object containing the property, but prefixed with an XPath-like expression to the property instance. For example, /O/screenTip[0]/O/[gosales_ml].[Order Discount] - Property screenTip of Order Discount object. Maps to a parameter of type i18nstring in the action logs. Represents the value being set on a property being created or updated. If it is an XML fragment, all reserved XML characters must be escaped, according to W3C standards. For example, the less than character must be encoded as "<". Identifies whether a given property value is a simple or a complex property. Complex. Specifies that the corresponding property value is of type complexPropertyValue. The value is an XML fragment, and child properties are created from any element or attribute definitions that exist in the value. Simple. Specifies that the corresponding property value is of type simplePropertyValue. The specified value is set explicitly on the property, and no child properties are created even if the value is an XML fragment. Maps to a string and represents a simple value being set on a property. The value is simple in that child properties will not be inferred from it, even if the value is an XML fragment and the property in question is complex, in that it can contain child properties. For example, the following value being set on an instance of an existing package/functionSets property: <functionSet><functionSetID>V_DB2</functionSetID> </functionSet> <functionSet><functionSetID>V_MSAccess</functionSetID></functionSet> <functionSet><functionSetID>V_Oracle</functionSetID></functionSet> The value of the functionSets property will be set to this XML fragment and child properties are not created for the functionSetID elements that appear in the value. Maps to a parameter of type stringCollection in the action logs. Represents a collection of strings that are encoded as an XML fragment with a root element called stringCollection and each string in its own item element. However, all reserved XML characters are escaped in the encoded value. For example, a parameter of this type with strings "COUNTRY", "SALES", and "PRODUCTS" would be encoded as <stringCollection><item>COUNTRY</item><item>SALES</item><item>PRODUCT</item></stringCollection> A set of parameters representing the parameter list applicable to the DBImport action being executed against a relational data source. Represents the parameter list applicable to the DBImport action being executed against a multidimensional (SAP BW) data source. SAP BW objects have a short name (short description or caption), a long name (long description), and a technical name (unique name). Specifies which name to use for the imported objects. Use short names. Use technical names. Use long names. Specifies whether or not to enhance the model for SAP BW organization of objects. Enhance the organization of objects to reflect SAP BW objects more closely. Use the default object organization. Specifies which languages from the SAP BW data source should be imported into the model. These languages are added to the model if they do not already exist in the model. Specifies whether or not to create conformed dimensions for all applicable imported dimensions. A set of parameters representing the input parameter list specific to the Create action, and the Verify action for Create. Specifies the object type to create. Query Subject Query Item Relationship Shortcut Folder Package Project Relationship Shortcut Custom Object. RESERVED for future use. Runtime Object. RESERVED for future use. Calculation Filter Parameter Map Parameter Map Entry Security View Query Item Folder Function Namespace Data Source Dimension Level Scope Relationship Hierarchy Update Subject Measure Folder Measure A set of parameters representing the input parameter list specific to the Delete action, and the Verify action for Delete. Can be any object in the model except: root container objects. These are objects within the root project object, namely dataSources, packages, parameterMaps, securityViews, and the root namespace. query items that belong to datasource query subjects (dbQuery). Can be any property in the model. A set of parameters representing the input parameter list specific to the ImportTranslations action, and the Verify action for ImportTranslations. Specifies the locale used as the search criteria for properties that are being translated. The default is the locale ID of defaultLocale in the model. Specifies that only the properties in these locales are updated when importing the translations. If not specified, all locales in the model except for the input parameter keyLocale are processed. The set of objects to which to apply the translations are restricted to this object or any of its descendants. If not specified, all objects in the model are processed. A set of parameters representing the input parameter list specific to the Move action, and the Verify action for Move. Specifies the object being moved. A set of parameters representing the input parameter list specific to the Modify action, and the Verify action for Modify. Specifies the simple property being updated. The property is simple in that it is does not have any child properties. The value used to update the property. A set of parameters representing the input parameter list specific to the DynamicImportPublish action. The name of the package to be published. If omiited, the package will be named after the cube name. The following parameters are for DB2, MSAS, Finance (CL), and Planning (CR). The name of the parent catalog. This name is required for all datasource types except Powercube. The following parameter is for Finance (CL) and Planning (CR). The name of the parent schema. This name is required for Cognos Finance and Planning datasources. The name of the cube. This name is required for all datasource types except Powercube. The following two parameters are optional for DB2 (DO). The collection of the locales to be imported. This collection is used to create a map between a locale and an alias table (see the input parameter below. The collection of the alias names corresponding to the above collection of locales. This collection and the locale collection is used to create a map between a locale and an alias caption table. The sizes of the two collections must be equal. A set of parameters representing the input parameter list specific to the Publish action, and the Verify action for Publish. Specifies the maximum number of versions that the published package can have in IBM Cognos 10. If the value is -1, then versioning is turned off. Specifies the maximum number of versions that the published package can have in the Framework Manager model. If the value is -1, then versioning is turned off. Indicates whether or not to externalize the query subjects included in the package that are marked for externalization. Do not externalize the query subjects. Externalize the query subjects. Maps to the bmtactionlog root element that appears in a Framework Manager action log. An action log can be executed from within Framework Manager, by the Framework Manager script player, or by the Framework Manager Metadata Service. Maps to a SOAP request intended to be handled by the Framework Manager Metadata Service. Specifies the name of the catalog. Specifies the name of the schema. Specifies the name of the cube. A dimension that can be conformed to the target. Note: Applies to multidimensional dimensions (specifically of type SapBW) only. If set to true, a grouping and aggregation of the projection items is triggered. The name of an IBM Cognos 10 data source connection object. The name of an IBM Cognos 10 data source connection signon object. The password for authenticating to a given IBM Cognos 10 data source connection. The user name for authenticating to a given IBM Cognos 10 data source connection. The password for authenticating to a given Cognos PowerCube data source connection. Specifies if the cube password for authenticating to a given Cognos PowerCube data source connection is encrypted (0 means not encrypted). The name of an IBM Cognos 10 data source object. A data source object in the model. Specifies the name of the data source. Represents the level of detail for the report. Only errors are reported. Errors and warnings are reported. Errors, warnings and information about key transformations that might have been used are reported. The highest level of detail. In addition to any of the above items, planning or execution information are reported. Specifies the expression to be executed. The gateway configuration parameter. Must conform to the ImportSpec.xsd. Value represents a tree of the objects found in a given import source, and indicates which object is selected to be processed. For the browse actions, an item containing the "namePattern" element is the item to be expanded. For the import actions, items having a value attribute of "true" or "partial" are the items to be imported. The import source can be either a data source or a Framework Manager model. Must conform to the ImportSpec.xsd. Value represents a tree of the objects found in a given import source, and indicates which object is selected to be processed. For the browse actions, an item containing the "namePattern" element is the item to be expanded. For the import actions, items having a value attribute of "true" or "partial" are the items to be imported. The import source can be either a data source or a Framework Manager model. Must conform to the ImportSpec.xsd. The value represents a tree of the objects found in a given import source, and indicates which object is selected to be processed. For the browse actions, an item containing the "namePattern" element is the item to be expanded. For the import actions, items having a value attribute of "true" or "partial" are the items to be imported. The import source can be either a data source or a Framework Manager model. Specifies the rule that governs publication and visibility of the object. Exclude. The object is not published unless it is required. For example, if it is referenced by another object that is being published, or if it is involved in the relationship path between two objects that are being published. If this object is required, it is published but not visible. Hide. The object is published but not visible. Include. The object is published and is visible. Specifies a join option to create outer joins. Specifies a join option between each imported query subject and all existing query subjects in the model. Specifies a join option between the imported query subjects. Specifies a join option to use primary and foreign keys. Specifies a join option to use matching query item names that represent uniquely indexed columns. Specifies a join option to use matching query item names. Either a namespace, a folder, the parameterMaps container object or the dataSources container object. A value of 0 means Do not execute. Represents a locale that must exist in the model, under the project/locales property. Represents the network path to an existing Framework Manager project. It could be a relative path to the base project. To be used in case of running action log stripts on temporary location. The multidimensional dimension that represents the conformed dimension target. Specifies what to do if another object exists with the same name. The object is not created and an exception is thrown. Create the object but make its name unique by appending a sequence number to it. Specifies what to do with an imported object if its name conflicts with that of an object that already exists in the model. Do not import the object. Import the object but make its name unique by appending a sequence number to it. Can be any object in the model. Specifies a name for the new object. Indicates whether or not the package already exists in the target location. In Framework Manager, this value is based on the result from a prior call to the IsModelViewPresent action. A package already exists with the same name and is in the same location as that of the specified package. No package exists with the same name in the same location as that of the specified package. Specifies the name of the parameter. Specifies the value of the parameter. Specifies the name of a prompt. Specifies the value of a prompt. Specifies the type for the requested package. RESERVED for internal use only. Framework Manager project on the network. Cognos 10 Content Manager package. RESERVED for internal use only. Conforms to the ImportSpec.xsd. Value represents a tree of the objects that depend on the upper-level objects, which in turn depend on the selected object (not shown on the tree). Specification not yet available. need details from CQE Contains a collection of key-value pairs used to query a database. Either a query item or calculation object in the model. A query subject in the Framework Manager model. A query subject or dimension in the Framework Manager model. Any object in the Framework Manager model that can be reported against, or can contain such an object. These objects are: query subject, dimension, query item, query item folder, measure, measure folder, hierarchy, level and calculation. An update subject in the Framework Manager model. A package object in the model whose isRoleBased property is set to false. The objects that can be directly used in reports. For more information, see the Framework Manager model schema. A package object in the model whose isRoleBased property is set to true. Represents the network path to the current schema version. Either a security view or regular package in the model. A regular package is one whose isRoleBased property is set to false. Indicates whether to process only the selected objects or the selected objects and their children. Process selected objects only. Process selected objects and their children. Defines a shortcut to an object. Represents the source object for the action. Specifies the location of the Cognos 10 server. Specifies the name of the package. Represents the target parent object for the action. Either a namespace or a folder. A multidimensional query subject that serves as the target of the conformed dimension. Maps to a transaction element in the action log. Returns the object security specifications on an object or set of objects. The resulting specifications consist of every role, account, and group currently in use in the model, with a corresponding rule (either allow, deny, or unspecified) for each. If an object is not directly secured, the rules are taken from the nearest parent object that is directly secured. If no such object exists, the rule returned for every role in the model is set to unspecified. If no roles exist in the model (that is, object security has not been specified on any object in the model), only the role called Everyone is returned, and its rule is set to unspecified. If multiple objects are specified, the rules for every role are merged. Conflicting rules are resolved in the following order of precedence: deny, allow, and then unspecified. The translations file contains a special header record, with each field being the XML language ID of a locale in the model. For every multilingual property found, a record is created in the translations file. For every multilingual instance of the property, a field within the record is created. For example, if an object has a name property that has the value "my value" in English and the value "mon valeur" in French, the translations file will contain a header record containing fields "en" and "fr", as well as another record containing fields "my value" in the "en" column, and "mon valeur" in the "fr" column. Adds a set of locales to the model. For each locale, the following occurs: A new instance of the locale property is created under project/locales in the model. The locale property value is set to the locale ID. For every multilingual property collection in the model that has a locale attribute, a new property instance is created. The locale attribute of the new property instance is set to the locale ID. The value of the new property instance is set to the same value as the property instance whose locale attribute matches the locale ID of the active locale, but is prefixed with the locale ID. For more information about multilingual properties, see the Framework Manager model schema. For more information about the active locale, see SetActiveLocale. The set of locales to be added to the model. Represents a language that must exist in the model, under the project/locales property. When creating the new multilingual property instances, the property values are based on the corresponding values of the same property in this locale. If not specified, the active locale is used as the key. For more information about the active locale, see SetActiveLocale. fr-ca en-us Creates a new property and optionally sets its value. Specifies the object to which this property relates. Specifies the parent property to which this property relates. Specifies the name and location of the property to be created. Identifies that the corresponding property value is simple. Identifies that the value set on the newly created property is simple. Identifies that the corresponding property value is complex. Identifies that the value set on the newly created property is complex. Specifies the name of the property added to the object or parent property. [].[securityViews].[db2_pkg] securityView/functionSets Takes in a parent object and a child object, and returns a virtual reference prefixed with the ID of the parent and suffixed with the last part of the ID of the child. Can assist in the communication of a refobjViaShortcut property as a single virtual object reference. Specifies the object to which the reference relates. Specifies the handle of the child object to which the reference relates. Specifies the compound name of the output object reference. Not yet available for this action. Sets or resets the flag to cancel any currently running action. Note: This is the only action that must be called in a separate thread, concurrent with another running action in the same session. Represents the value of the cancel flag. When its value is set to 1, the next operation is cancelled and the flag is cleared (reset to 0). Clears the cancel flag. Done immediately before calling an action, this clears any residual cancel setting. Sets the cancel flag. Use in a separate thread to stop waiting for the result of the last action. The cancel action returns normally, and a cancelled exception is thrown by the thread running the cancelled action. Cancel is checked at different points by different service components (including database servers). An exception is thrown as soon as the cancel has been detected and acted on by any part of the currently running action. Not yet available for this action. Verifies the integrity of the model. For a complete list of the tests that are performed, see "Verify_Model_tests.xls". If specified, this object and its descendants are verified. If not specified, the entire model is verified. Value conforms to the modelErrors.xsd. Contains the errors and warnings that were encountered as a result of running this action. Not yet available for this action. Takes in dimensiont that represents the conformed dimension target, and returns the list of every multidimensional dimension that belongs to a different data source than the data source of the conformed dimension target. Use this action to generate candidates for ConformedDimensionsDetect. Note: Applies to multidimensional dimensions (specifically of type SapBW) only. Not yet available for this action. Takes in a dimension that represents the conformed dimension target and a list of dimensions that represent conformed dimension candidates, and transforms the candidates into conformed dimensions of the target. The conformed dimension becomes a shortcut to the target dimension, and the references to its attributes are redirected to the query items of the target dimensions. Note: Applies to multidimensional dimensions (specifically of type SapBW) only. Specifies what to do if one of the candidates cannot be conformed. Conformed dimensions are created for the candidates that can be conformed. No conformed dimensions are created and an exception is thrown specifying which candidates cannot be conformed. A shortcut to a multidimensional dimension that serves as the conformed dimension target. Not yet available for this action. Takes in a dimension that represents the conformed dimension target and a list of dimensions that represent conformed dimension candidates, and returns the subset that can be conformed. Result is intended to serve as input to ConformedDimensionsCreate. Note: Applies to multidimensional dimensions (specifically of type SapBW) only. (more details about conformed dimension can be found in CR0172 "DBC0033, SAP BW Conformed Dimension Support in Framework Manager.doc" Not yet available for this action. Copies a set of objects and returns a reference to each created copy. Relationships or relationship shortcuts cannot be copied directly. Instead, they are copied if either one or both of their ends is specified to be copied. If both ends are specified, then the copied relationship has both copies as its own ends. Otherwise, if only one end is specified, the copied relationship has the specified end's copy as one end but its other end remains the same as that for the source relationship. The copied relationship is placed in the nearest common ancestor folder or namespace of its two ends. If you copy object A, and it has references to another object, object B that is also being copied, any references within the object A copy will refer to the object B copy. If a package is specified, then the sole securityView it references is also copied and the copied package then references the copied securityView. A copied object is always left unsecured, regardless of whether or not its corresponding source object was secured. For more information, see the SetObjectAccess action. Represents the reference to the created copy. [oracle_gosales].[New Folder] [oracle_gosales].[EUROCONVERSION] Counts the number of rows in the result set of a given query subject or a dimension. Note: For the query subject representing the facts of an SAP BW data source, the number of rows is always 1. Contains the number of rows in the result set. Creates a new object under a given target parent. Defines the object created by the action. 1 [db2_gosales1] Takes in a number of query items and creates standalone calculations in the specified folder or namespace. Specifies the input query items for the action. Represents the calculation that is created in the specified folder. Not yet available for this action. Creates shortcuts to a given set of objects, places them under a given target, and returns a reference to each created shortcut. Specifies the object for which a shortcut is created. Note: The model does not support shortcuts to shortcuts. If the specified object is a shortcut, the new shortcut is created to its target, not to itself. Specifies whether or not relationship shortcuts should be created. No relationship shortcuts are created. Relationship shortcuts are created to relationships found between the selected query subjects, and between any selected query subject and any other query subject in the model. Relationship shortcuts are created only for relationships found between the selected query subjects. Represents the created shortcut. NULL [SQL_GoSales].[ORDERDETAIL] Expands a database tree view from which objects can be selected and imported. This action does not impact the model. The browse tree is intended as a base to modify for input to either the DBimport or ModelImport actions. Note: Modifies input parameters. Imports database objects. This action impacts the model. Please consult "FM Relational Database Import FS.doc" for more information. [SQL_GoSales] 0 1 1 0 0 0 0 RESERVED for internal use. Detects relationships in a given set of query subjects. Relationships are detected through the primary keys and foreign keys in a given data source against a specific data source. Used by TransformRelationship when the value for its joinOptionProcessKeys input parameter is 1 (use primary and foreign keys). This action impacts the model. Note: Not applicable for SAP BW data sources. Specifies whether to create joins between selected query subjects or between each of them and others. Joins are created between selected query subjects. Joins are created between each selected query subject and existing query subjects. Not yet available for this action. RESERVED for internal use. Converts an arbitrary string into a valid SQL name. This action does not impact the model. Note: Not applicable for SAP BW data sources. The original name. The output name that is suitable for the Cognos Query Engine parser. Not yet available for this action. RESERVED for internal use. Retrieves all joins, using primary and foreign keys, between two database tables, based on corresponding query subject names. This action does not impact the model. Note: Not applicable for SAP BW data sources. The database ImportSpec. This ImportSpec node contains at least two child nodes representing the two tables. Each child node must contain a "namePattern" element. For more information, see the file called ImportSpec.xsd. Represents the list of joins between the two input database tables. Not yet available for this action. Imports an IQD (Impromptu Query Definition) file. This action creates a database query subject based on the sql statement specified in the IQD file. Note: This action is used by Cognos Metrics Loader (PD). The IQD file path location. A folder in the model where the query subject will be created in. The specification of the IQD file. This spec node conforms to either the "dbConnectionsSpec.xsd" or "iqdFileSpec.xsd". Not yet available for this action. Tests a relational or multidimensional database connection string. Note: This action is used by Cognos Metrics Loader (PD). The raw or full connection string. The optional user name (if the first param is a raw connection string specified a prompt for user name. The optional password (if the first param is a raw connection string specified a prompt for password. Not yet available for this action. Releases the connections to all databases currently connected. Should be called after a DBImport or a TransformRelationship action. This action does not impact the model. RESERVED for internal use. Imports an individual stored procedure. Used for creating a query subject from a database stored procedure. This action impacts the model. Note: Not applicable for SAP BW data sources. A stored procedure query subject in the model. An ImportSpec node that contains the specified stored procedure in the data source. This specified item must contain the "namePattern" element. For more information, see the file called ImportSpec.xsd. Not yet available for this action. Removes a set of objects and/or properties. Whenever an object is deleted, any references to it become broken. Each broken reference is handled as follows: If the property containing the reference has allowMissingTarget=true specified in the mapping section of the file CR1 Behaviors.xml, the property is left untouched. If the object containing the reference property has a status property (for example, a relationship) or is a child of an object that has a status property (for example, a query subject), the status property is set to needsReevaluation. To see which objects have a status property, see the Framework Manager model schema. If the property containing the reference does not have allowMissingTarget=true, the deletion cascades as follows: the property is deleted, and if the property is mandatory (as defined in the model schema) with respect to its parent (property or object), that parent is also deleted. The deletion propagates up the ancestry until either the deleted parent is an object (such as a query subject or query item), or a property that is non-mandatory with respect to its parent. Typically, properties that allow missing (broken) references are complex properties that contain valuable information which would be lost if the property were deleted, and that can be manually repaired. Examples include expressions and compound keys. Properties that do not allow missing references are simple properties. Examples include shortcut targets and relationship ends. If a package is specified, its corresponding security view is also deleted. If the package is role-based, any object specified within that package that is not referenced by any other role-based package has its secured property reset to unsecured. Note: Not applicable to query items and query item folders belonging to query subjects of type database or multidimensional. [].[packages].[P3] RESERVED for future use. Not yet available for this action. RESERVED for internal use. Executes a query services (QSAPI) request. For more information, see the files qsapi2.xsd and query_cr1.xsd. Not yet available for this action. RESERVED for internal use only. Upgrades the model to conform to the current schema version. Not yet available for this action. Takes in a set of security views and/or packages and returns a unique set of pairs, each pair containing an object and its corresponding rule. The includeRule is set to either Include or Hide. The process is as follows: Initialize result set for this view to be empty. Iterate through each set S in the view and group all viewRefs in a set V and all objects in a set O Recursively evaluate every view in V and add each object/rule combination to the result set for this view. In the case of a conflict, that is if the same object occurs repeatedly in the views with conflicting rules, Include takes precedence over Hide. Process every object in O in order of shallowest, or nearest to the root namespace in the model, to the deepest, and do the following: If the includeRule is Include or Hide, add the object and all its descendants to the result set with the given rule. If any of the objects being added already exist in the result set, then replace its current rule. If the includeRule is Exclude, then remove the object and all its descendants from the result set. If multiple views are passed into the action, each is evaluated on its own, and all result sets are unioned with Include taking precedence over Hide in the case of conflicts. Note: Not applicable to models based on SAP BW data sources in this release. When role-based packages are specified to this action, this option specifies whether or not to merge their evaluation results with those for the "Everyone" role. When evaluating role-based packages, do not merge the evaluation results with those for the "Everyone" role. When evaluating role-based packages, merge the evaluation results with those for the "Everyone" role. Not yet available for this action. Expands (resolves) a parameterized string based on the current settings of session parameters and parameter maps. Examples of session parameters are "account.defaultName", "account.personalInfo.userName", and "runLocale". Represents the input parameter value. Represents the expanded value of the input parameter. Not yet available for this action. Provides an explanation for an action found in an action log. Specifies the action. Need a schema for this? Specifies the action. Need a schema for this? Specifies the level of explanation that will be provided. When set to 1, detailed explanations are provided. A summary-level explanation is returned for the given action. A detailed explanation is returned for the given action. Contains the text of the explanation. Not yet available for this action. Builds a translations file from the multilingual properties in the model. Note: SAP BW variable information is stored using custom properties. Locale-specific information is stored in these custom properties, but is currently not exported to, or imported from, translation files. The set of locales to be exported. All must exist in the model. If not specified, all locales in the model are exported. The set of objects from which to extract the multilingual values that are restricted to this object or any of its descendants. If no objects are specified, all objects in the model are processed. E:\sanity\fm_690\win32\bin\myTranslations.csv fr-ca Executes an expression and returns the result set. Represents the expression to be executed. Not yet available for this action. Used as part of centralized management of data sources. Given a set of data source identifiers, the action looks up a data source in the model and if it is not found, creates a new one. Place holder only. Sets the value to a symbolic indicator of the data source that is used in qualifying table names in the SQL of query subjects. Note: Also an output parameter, if overwritten during execution. Specifies the name of a cube. Note: Applies only to multidimensional data sources Indicates whether a matching data source existed in the model or needed to be created as a result of executing this action. Data source already exists in the model. Data source was created. oracle_gosales GOSALES RESERVED for internal use. Not yet available for this action. Returns the current Framework Manager SDK version. Contains the current version of the Framework Manager SDK. Not yet available for this action. Takes in a pair of query subjects and determines if there are any relationships between them. Note: Not applicable to models based on SAP BW data sources. Specifies the first query subject. Specifies the second query subject. Specifies the type of search to perform. When set to 0, a quick search is performed. When set to 1, an exhaustive search is performed. Quick. Finds any relationship having both: one of its ends matching one of the ends passed into this action, AND its other end matching the other end passed into this action, OR any shortcut to it. Exhaustive. Finds any relationship having: one of its ends matching one of the ends passed into this action, OR any shortcut to it, AND its other end matching the other object passed into this action, OR any shortcut to it. Represents a relationship object in the model. Not yet available for this action. Returns the gateway configuration parameter. Not yet available for this action. RESERVED for internal use. Returns user selection for ambiguous connection and/or sign-on for a given data source that is set by SelectDataSourceConnection. Not yet available for this action. Clears the cache of all datasource connection information for the current session. ClearDataSourceCache should be called when logging off or resetting any cached datasource values. This action does not impact the model. Not yet available for this action. RESERVED for internal use. Returns information about a given data source. Note: Also an output parameter, if overwritten during execution. Note: Also an output parameter, if overwritten during execution. Not yet available for this action. Returns the default locale in the model. For more information, see SetDefaultLocale. Value is that of the project/defaultLocale property in the Framework Manager model. Not yet available for this action. Takes in a locale ID and returns the ID of the locale in the model that best matches it, using CRN's standard locale-matching algorithm. If multiple matches are found, the first matching locale is retuend. If no matches are found, the default locale (refer to SetDefaultLocale action) is returned. [].[packages].[P3] Takes in a set of objects and returns the nearest common ancestor between them. Returns the nearest parent object for the input object. Not yet available for this action. Returns the ancestry of a given object, in top-down order starting from the root. Note: The object passed in is also returned as one of the ancestors. Specifies an ancestor of the object passed to the action. Not yet available for this action. Returns information about an object, specifically whether or not the object is included, excluded or hidden with respect to every package or security view in the model. The role-based packages for which the object is unsecured, that is no rule is specified for it or any of its ancestors, are not returned. A triplet is returned for each security view or package that gets returned, consisting of: the same source report object passed into the action, the current security view or package, and the inclusion rule for the report object current security view or package. Not yet available for this action. Takes in a set of credentials and attempts to authenticate to the Cognos 10 server whose location is specified in the configuration parameter called sdk. If authentication is successful, a session is established with the Cognos 10 server and the session's passport ID is returned. If authentication fails, an exception is thrown. Must conform to the formFieldVars section of BI Bus Header specification. It can be NULL, which means that the authentication is attempted as anonymous. Specifies the ID of the established Cognos 10 server session. Not yet available for this action. Returns a list of prompt values set during the session, either as a list of prompt-value pairs, or as a DOM element. Specifies the names of the prompts. Specifies the prompt values. A node that conforms to the "parameters" element of query services request (for more information, refer to the "Parameters" section of the Cognos 10 SDK documentation). Not yet available for this action. RESERVED for internal use. Returns the query processing model, databaseOnly versus limitedLocal, for a given data source. Specifies the mode of processing for this data source. Not yet available for this action. Returns session parameters and their values for the current user for the current session. Specifies whether to retrieve original parameter values or overrides. For more information, see SetRuntimeParameters. Only original values are requested, no overrides. Only overridden values are requested. Specified in runtimeParameters.xsd. Not yet available for this action. Determines the set of security objects found in the access list of each security view in the model, and returns this set in the form of a one-to-many mapping between the security object and the security views that contain it. Note: A security object is either an account, a group, or a role. Specifies whether to return information pertaining to regular packages, role-based packages, or both. Return information pertaining to both "regular" and "role-based" packages. Return information pertaining to "regular" packages only. Return information pertaining to "role-based" packages only. Conforms to the securityObjectSpec.xsd. Not yet available for this action. Returns all locales that exist in the model, as found in the project/locales property. Represents all locales that are supported for the model. Not yet available for this action. Imports a set of translations into the model. For any multilingual property, its value in the keyLocale parameter is searched against the corresponding keyLocale column in the translations file. If a matching record is found in the translations file, then any other value for the property, that is any other value in the other locales, is updated with the value in the corresponding locale (if one exists) from the found translations record. For more information about the translations file format, see ExportTranslations. If the value being updated refers to an object name which collides with the name of another object, then the update still occurs but the name of the value is made unique by appending a sequence number to it. Note: SAP BW variable information is stored using custom properties. Locale-specific information is stored in these custom properties, but is currently not exported to, or imported from, translation files. Represents the set of multilingual properties that were updated as a result of this action. E:\sanity\fm_690\win32\bin\languages.csv en-us fr-ca Determines if a given package has already been published to the Cognos 10 server and, if so, returns its path as found in Cognos 10, as well as corresponding versioning information. Lists the names of the packages that are found in Cognos 10 that match the name of the selected package. Specifies the retention value from Cognos 10 for model objects with the selected package. Specifies the number of models versions that already exist in the package in Cognos 10. Not yet available for this action. Establishes a link to the given object under the selected parent. Specifies the parent object that contains the link in the current model. The object must be either a namespace, a folder, the parameterMaps container object, or the dataSources container object. Specifies the connection string of the project that contains the object to be linked. Specifies the object to link to in the target model and is encoded as an Xpath-like expression. Specifies whether to persist the link or not. The link only exists for the current user session and is not saved when the model is saved. The link is saved when the model is saved. [link] E:\my_projects\link_segment_master\New Folder\NewFolder.cpf /project/namespace/folder 0 Transforms an embedded filter or calculation into a stand-alone filter or calculation, and replaces the embedded filter or calculation with a reference to the newly created object. If not specified, a default name is provided for the newly created object. Specifies either a calculation or filter. Not yet available for this action. Takes in an object type and a target parent and returns a name for the specified object type that is unique in the context of the specified target parent. The base name for the object can be optionally specified as the newObjectName parameter. If not specified, a reasonable default is provided. The base name is returned as the new name if it is unique in the target context, otherwise a unique name is created by appending a sequence number to the base name. Specifies the type of the input object. Specifies the action to take in the event the new object name already exists. If the value of newObjectName collides with another object name, an appropriate sequence number is appended to it. If the value of newObjectName collides with another object name, it is prefixed with "Copy of". The value of newObjectName is always prefixed with "Shortcut to". If the value of newObjectName collides with another object name, it is prefixed with "Shortcut to". Represents the assigned unique name for the new object. Not yet available for this action. Merges the specified source objects into a new model query. Sources can be query subjects, dimensions, query items, query item folders, measures, measure folders, shortcuts, calculations, filters, relationships and relationship shortcuts. Selecting a relationship or a relationship shortcut has the same effect as selecting the left and right end objects as the sources. The Merge action may optionally create new relationships (or relationship shortcuts) between the target and the query subjects that were related to any of the source query subjects, unless the other end of the relationship also appears in the selected sources, and the expression of the relationship includes a query item that no longer appears in the target. Specifies the source object to merge. Specifies whether or not to create a relationship (and relationship shortcut) between the new merged query subject and the query subjects (and shortcuts) that were related to the sources. Retain the merge source objects passed into this action. Delete the merge source objects passed into this action. Specifies the merged target query subject that was either specified as the mergeTargetObject input parameter or created if the input parameter was NULL. NULL [oracle_gosales].[New Query Subject1] [oracle_gosales].[New Query Subject2] 0 RESERVED for future use. Expands a node in a model browse tree. This action does not impact the model. Note: This action modifies input parameters. Not yet available for this action. RESERVED for future use. Compares the current package in the model with a version that already exists in Cognos 10 and returns a difference result document. The passport to a valid Cognos 10 session. An XML document that describes the difference results. A numeric return code to indicate success or failure. Not yet available for this action. Imports a Framework Manager model into a specified namespace or folder in a Framework Manager model. This action impacts the model. Specifies whether to display information regarding the results of the action. Do not display summary information. Display summary information. Specifies how to process namespaces or folder objects that are in conflict with existing objects. Do nothing for conflicting namespaces or folders, except what is specified for the nameConflictOptionImport parameter. Do not import the namespace or folder but keep processing its children, using the existing namespace or folder as the target parent for the copied children. In this case, the value for the nameConflictOptionImport parameter is not taken into effect for namespaces or folders. Specifies whether or not to permit empty namespaces or folders to be imported. Do not import empty namespaces or folders. Import empty namespaces or folders. ../temp/CRN_model_import/CRN_model_import.cpf [oracle_gosales] 1 Updates the value of an existing simple property, that is, one that has no child properties. In most cases, the property is updated with the specified value and the lastChanged property of the parent object is also updated accordingly. However, additional behavior can occur depending on the type of the property, as follows: If the specified property is the object's name, all references to that object, or any of its children, are updated with its name. For example, if the name of a query subject in namespace NS is being modified from "CTRY" to "COUNTRY", any object references with the value of [NS]. [CTRY] are updated to [NS.[COUNTRY]. Also, if the query subject has a query item named COUNTRY_CODE, any reference to that query item is also updated from [NS].[CTRY].[COUNTRY_CODE] to [NS].[COUNTRY].[COUNTRY_CODE]. If the specified property is the name of a package, the package's corresponding security view is also updated with the same name. If the specified property is the object being referenced on one end of a relationship or relationship shortcut, the parentage of the relationship or relationship shortcut needs to be re-assessed, as it must exist in the nearest common ancestor of its two ends. If the property being modified is the secured property of an object, all references to that object within role-based packages are removed. See GMS068 "Object Based Security". If the specified property is a calculation's data type, its usage and aggregate rules may also change in accordance with the aggregate transformation rules of Framework Manager. For more information, see "FM Usage AggregateTransformations.doc" If the specified property is a query item's usage, and it has changed from fact to some other value, both its regularAggregate and semiAggregate properties are set to unsupported. it has changed from some value other than fact, both its regularAggregate and semiAggregate properties are set to sum. it has changed from some value other to fact, its existing value for the corresponding promptType property must be set to serverDetermined. If the specified property is a query item's promptType and the corresponding usage property has a value of fact, then the value being set on promptType must be serverDetermined. If the specified property is a package's maxVersions property, and the value passed in is an empty string, then the property is removed from the model. Removal means that model versioning is turned off when the package is published to Cognos 10. /O/name[0]/O/[] db2 Updates the value of an existing complex property, one that contains other properties. A property that can contain child properties as defined in the schema. Specifies that the value of the complex property being updated is a string. Must conform to the same specification as the property in question. For more information, see the Framework Manager model schema. If true, an update is forced, even if the specified value is not valid. Moves a set of objects to a new target parent object. The following behavior may also occur: If an object is being moved to a different namespace, and the name of the object collides with that of another object in that namespace, the object is made unique by appending a sequence number to it. A relationship or relationship shortcut must always exist in the nearest common ancestor of its two ends. Whenever a query subject, or shortcut to a query subject, is moved, the location of any relationship to it may also be moved in order to meet this constraint. Conversely, if the user tries to explicitly move a relationship, then either or both of its ends may also be moved in order to meet this constraint. [New Namespace] [SQL_GoSales].[CONVERSIONRATE] [SQL_GoSales].[COUNTRY] [SQL_GoSales].[EUROCONVERSION] Populates a parameter map object based on entries in a specified file, where every key-value pair is delimited and appears on a separate line. Specifies the path name of the source file containing the entries for the parameter map. Specifies the action to take in the event that a naming conflict occurs. Update existing entries. Create new entries, but make their names unique by appending a sequence number to them. Not yet available for this action. Security filters can be based on other security filters defined for user groups and roles. In such cases, this action constructs an expression based on all inherited security filters, when it is passed a security filter definition. Specifies the input security filter definition. Specifies an expression that results from the AND-ing of relevant security filters. Not yet available for this action. Publishes a package to either the network or Cognos 10. Builds a new model containing the subset of the existing model as defined in the package. The published model contains the objects included in the package. Any objects that are required by the included objects are also published, to ensure that no broken object references exist in the published model and no unexpected cross-join errors occur. If object security exists in the model, then the security views for all role-based packages are written to the published model; however, the only objects in these views are those being published. Objects that are not being published are ignored. A special role-based view named with an underscore (_) is also created, which contains an evaluation of only the secured objects within the root namespace hierarchy. Specifies the path to the published package using the active locale. For more information, see the "SetActiveLocale" action. Must conform to the securityObjectSpec.xsd. Its value represents the list of those who can administer (which includes republishing and deleting) a package that has been published to Cognos 10. The list is usually the same as the list found in the Framework Manager model as the value of the property package/adminAccess/decisionRole. If the package is being published for the first time and the list in the Framework Manager model is empty, the value is set to whomever has SetPolicy permission on the published package in Cognos 10. [].[packages].[db2_pkg] 2 /content db2_pkg 0 0 0 Removes a set of locales from the model. For every locale that is requested for removal, the following occurs: The instance of the locale property under project/locales that matches the locale ID is deleted. The locale instance of any multilingual property whose locale ID matches is deleted. For a description of multilingual properties, see AddLocale. Specifies the set of locales to be removed from the model. ja-jp Removes specified session parameters from the session. runLocale Reorders a set of object(s) before a given target parent, or at the end if the target object is NULL. All specified objects must belong to the same parent. Note: Not applicable to query items and query item folders belonging to multidimensional query subjects. Specifies the object being reordered. Specifies that all objects are moved before this object. Parameter can be NULL, in which case the reordered objects are moved to the end. [oracle_gosales].[EUROCONVERSION].[EUROYEAR] [oracle_gosales].[EUROCONVERSION].[COUNTRYCODE] Reruns a Verify action on a given set of objects, and runs any possible repairs on them, if necessary. Specifies the object to be repaired. [oracle_gosales].[New Query Subject] [oracle_gosales].[New Query Subject] [oracle_gosales].[New Query Subject] [oracle_gosales].[New Query Subject] [oracle_gosales].[New Query Subject] [oracle_gosales].[New Query Subject] [oracle_gosales].[New Query Subject] RESERVED for future use. Not yet available for this action. When no argument is specified, all prompts set during the session are removed. The overloaded form, with the single argument, only sets a flag to either use prompt values that are set during the session, or not use them. Specifies whether prompt values that are set during the session are to be used. Use the prompt values set during the session Do not use the prompt values set during the session. Changes a set of specified object references to point to a specified object. Specified in the file called retargetObjectReferencesSpec.xsd. Specifies the object reference properties updated as a result of executing this action. Not yet available for this action. Retrieves and returns key-value pairs for a given query item-based parameter map. Note: Query item-based parameter maps for SAP BW data sources are not supported in this release. Specifies the query item-based parameter map for which to return the key-value pairs. Represents the keys retrieved for the specified parameter map. Represents the values retrieved for the specified parameter map. Not yet available for this action. Takes in a specified object and creates a new project that contains a copy of the specified object and all its descendents. The specified object is then removed from the current project and replaced with a link to the copied object in the newly created project. Specifies the object to be segmented, whose type must be one of the following: namespace, folder, parameter map, data source. The path of the model to be created that will contain the new segment. Specifies that the model to be created will be placed under source control, and will be in the path within the repository, as specified here. Value syntax is dependent on the source control system in use. We should still clarify this syntax. [oracle_gosales].[New Folder] E:\my_projects\link_segment_master\New Folder\New Folder.cpf Captures user selections for connection and/or signon information, when more than one is available to this user for a data source. FM_UNITTESTS_SAMPLEDB_OR Market_Research Captures user selections for data source signon information when none is provided in the connection string. FM_UNITTESTS_SAMPLEDB_OR Market_Research GOMR0104 GOMR0104 Captures user selections for connection and/or signon information. This action works similarly to the SelectDataSourceConnection and SelectDataSourceCredentials actions. The difference is in the input parameters. Value conforms to RS_API/specification/QF_XML_API.xsd. When connecting to Cognos Planning or Cognos Finance, an ASTicket element is required. Sets the active locale in the current user session. The active locale is the locale that is used by the Framework Manager SDK as the basis for specifying default object names. For example, in a model that has both English and French locales, if you call the Create action to create a query subject and do not specify a name for it: If the active locale is English, the default name of the object will be "New Query Subject". If the active locale is French, the default name of the object will be "Nouveau sujet de requeste". en-us Changes the default locale, the property project/defaultLocale, in the model. All object references are also updated, as the default locale is the locale in which they are encoded. For example, in a model that contains both English and French locales, where the default locale is English, if an object has the name "object" in English and "objet" in French, all references to that object appear as "object". If this action is called on the same model to change the default locale to French, then all references to the same object will now be changed to "objet". en-us Sets object-based security in the model. For more information, see the file called objectAccess.xsd. Specifies what the rule should be set for roles that exist in the model but not accounted for in the "objectAccess" parameter above. Remove any existing "allow" or "deny" rule(s) specified for the role(s). For any of the specified objects that are directly secured, leave all existing security rights specified on the give role(s) as is. Leave all existing security rights specified on the give role(s) as is for all specified objects, regardless of whether they are directly secured or secured via a parent object that is directly secured. Not yet available for this action. Updates the list of locales in a given package, in the package/locales property. This list represents the set of locales that appear in the published model. For example, in a model containing English, French, and German, if you publish a package, and this package has only English and French in its locales list, the published model will only contain English and French property values. Updating the list of locales has the following restrictions: The default locale must always appear in this list. For more information, see SetDefaultLocale. If this package includes another package, the set of locales must contain as a minimum all of the locales specified in that other package. [].[packages].[db2_pkg] en-us Associates a value, simple or complex, with a prompt name for the duration of a Framework Manager session. The values are used in subsequent actions that involve expressions containing prompts, for example TestQuerySubject, ExpressionQuery, or for modifying the definition of a model querySubject that uses that prompt. Specifies a complex prompt value (for more information, refer to the "Parameters" section of the Cognos 10 SDK documentation). Not yet available for this action. Sets the definition of a specified parameter map based on a pair of key-value query items. The key and value query items must belong to the same query subject. Note: Query item-based parameter maps for SAP BW data sources are not supported in this release. Contains a collection of key-value pairs used to query a database. Specifies the key for the query item. Specifies the value for the query item. [].[parameterMaps].[pM3] [SQL_GoSales].[PRODUCT].[PRODUCTNUMBER] [SQL_GoSales].[PRODUCT].[PRODUCTNAME] Takes in either a package or a security view and a list of user groups or roles and does the following: If the specified object is a security view, its corresponding access list is updated with the specified user groups or roles. The access list of a security view specifies those who can use the published package corresponding to the security view. If the specified object is a package, its corresponding admin access list is updated with the specified user groups or roles. The admin access list of a package specifies those who can administer the published package, including republishing and deleting it. Note: Security views are not supported for models based on SAP BW data sources in this release. Specifies whether or not the package is to be secured. Not secured. If specified, the corresponding input accessList parameter is ignored. Secured. If specified, the corresponding input accessList must be specified. Must conform to the securityObjectSpec.xsd. Its value specifies the list of those who can access the package or security view for report authoring and/or execution purposes in Cognos 10. [].[securityViews].[db2_pkg] 1 Everyone [Directory > Cognos] CAMID("::Everyone") Changes the value of a session parameter for the duration of the Framework Manager session. Effectively overrides the value initially associated with this parameter, for the current session. runLocale EN Replaces the definition for a given security view or package. Note: Security views are not supported for models based on SAP BW data sources in this release. Specifies a security view object in the model. [].[securityViews].[db2_pkg] [db2_gosales1] 2 RESERVED for internal use only. Compares the model version and the schema version to determine if the model needs upgrading. Represents the result of the comparison between the model and the schema. The specified schema path does not match the schema path that exists in the model. The schema version that exists in the specified model matches the version of the specified schema. The schema version that exists in the specified model is older than the version of the specified schema. The schema version that exists in the specified model is more recent than the version of the specified schema. Represents the version number of the model. Represents the version number of the schema. Not yet available for this action. RESERVED for internal use. Specifies a passport for a valid Cognos 10 session. No specification yet. An XML document that describes the search results. A numeric return code that indicates success or failure. Not yet available for this action. Plans, and possibly executes, a relationship between two query subjects or dimensions based on a given join expression. Plan means to generate and prepare the SQL, and describe the result set. [get details from CQE] Note: Not applicable to models based on SAP BW data sources. Specifies the name of the relationship to be generated. Specifies the reference for the left end of the relationship to be generated. Specifies the cardinality for the left end of the relationship to be generated. Specifies the reference for the right end of the relationship to be generated. Specifies the cardinality for the right end of the relationship to be generated. Not yet available for this action. Tests a data source object based on its corresponding connection information stored in Cognos 10. An exception is thrown if the test is unsuccessful. Not yet available for this action. Executes a request based on specified objects or their contained items and returns the result set. Specifies the filters to apply. If set to true, suppresses possible division-by-zero errors, and a NULL value is returned. Not yet available for this action. Creates a stand-alone grouping for a given set of query subjects or dimensions. The result is a set of query subjects that includes a single fact query subject and its neighboring query subjects or, a set of dimensions that include a measure dimension and its neighbouring dimensions. The created grouping is stand-alone in that all relationships within the grouping are self-contained and do not refer to any object outside the grouping. The primary distinction. Create Shortcut. Creates a shortcut to every source query subject (or dimension), and a relationship shortcut for every relationship that exists for each source query subject (or dimension). Move. Moves all source query subjects (or dimensions) to the specified target, except for any having a relationship where the other end of the relationship is not one of the source query subjects (or dimensions). In this case, creates a shortcut and new relationships between the other source query subjects (or dimensions), or the shortcuts created for them. Specifies where the new grouping will be placed. New Folder. Creates a new folder where this new grouping is placed. New Namespace. Creates a new namespace where this new grouping is placed. Same. The target parent for the grouping is the nearest common parent of all source query subjects (or dimensions). The overall behavior of the action changes depending on the value specified for this parameter. Single. The first source query subject (or dimension) specified is considered a fact, and all other source query subjects (or dimensions) are considered regular dimensions. This affects behavior as follows: If transformType is 1 (Move), the fact gets moved unconditionally. If transformTarget is 2 (Same), the grouping is created under the same parent as the fact, rather than the nearest common parent of all source query subjects (or dimensions) specified. If the starSchemaGroupingName parameter is not specified and transformTarget is either 0 (New Folder) or 1 (New Namespace), the name of the fact is used as the basis for the name of the folder or namespace being created to contain the grouping. Multiple. All query subjects (or dimensions) are treated like dimensions, and behavior does not differ from that described for the other parameters. Applicable only if transformType is 0 (New Folder) or 1 (New Namespace). If a name is not specified, a reasonable default is provided. Represents the output result set. [SQL_GoSales].[PRODUCT] [SQL_GoSales].[ORDERDETAIL] [SQL_GoSales].[PRODUCTFORECAST] [SQL_GoSales].[PRODUCTTYPE] 0 1 0 RESERVED for future use. Converts a query subject whose type is "stored procedure unknown" to a function object. This action impacts the model. Specifies the query subject to transform. The return parameter of the function (selected by the user). Specifies what to do with the source query subject, once the transformation has occurred. Do not remove the source query subject. Remove the source query subject. Not yet available for this action. RESERVED for future use. Converts all underscores, hyphens, and spaces to a single space, capitalizes the first character of each word in the name, and decapitalizes the remainder. For example, "BRANCH_CD" becomes "Branch Cd". This action impacts the model. Not yet available for this action. Determines regular aggregate and semi-aggregate rules for a given set of query items and calculations. This action impacts the model and behaves as follows: If the data type of the item is either numeric or time interval and its usage is fact: if the item is a query item, set both semiAggregate and regularAggregate to sum. otherwise (it must be a calculation), set both semiAggregate and regularAggregate to automatic. If the data type of the item is either numeric or time interval but its usage is not fact, set regularAggregate to count and semiAggregate to unsupported. If the data type of the item is neither numeric nor time interval, set both regularAggregate and semiAggregate to unsupported. Note: Not applicable to query items belonging to multidimensional query subjects as their aggregate values are predetermined. For more information about setting aggregate rules, see the topic "Modifying How Query Items are Aggregated" in the Framework Manager User Guide. [oracle_gosales].[CONVERSIONRATE] [oracle_gosales].[COUNTRY] [oracle_gosales].[EUROCONVERSION] [oracle_gosales].[ORDERDETAIL] [oracle_gosales].[ORDERHEADER] [oracle_gosales].[ORDERMETHOD] [oracle_gosales].[PRODUCT] [oracle_gosales].[PRODUCTFORECAST] [oracle_gosales].[PRODUCTLINE] [oracle_gosales].[PRODUCTTYPE] [oracle_gosales].[RETURNEDITEM] [oracle_gosales].[RETURNREASON] [oracle_gosales].[SALESBRANCH] [oracle_gosales].[SALESSTAFF] [oracle_gosales].[SALESTARGET] Determines the usage for a specified set of query items and calculations and updates their corresponding usage properties accordingly. This action impacts the model and behaves as follows: Usage is set to identifier if the item participates in a determinant key the item is involved in a relationship the item is of type date or time Otherwise, usage is set to fact if the item is type numeric. Otherwise, usage is set to attribute. Note: Not applicable to query items belonging to multidimensional query subjects as their usage values are predetermined. For more information about setting usages, see the topic "Modifying How Query Items are Aggregated" in the Framework Manager User Guide. This action is invoked explicitly during Determine Usage, implicitly on a database import, or when creating a query subject. [oracle_gosales].[CONVERSIONRATE] [oracle_gosales].[COUNTRY] [oracle_gosales].[EUROCONVERSION] [oracle_gosales].[ORDERDETAIL] [oracle_gosales].[ORDERHEADER] [oracle_gosales].[ORDERMETHOD] [oracle_gosales].[PRODUCT] [oracle_gosales].[PRODUCTFORECAST] [oracle_gosales].[PRODUCTLINE] [oracle_gosales].[PRODUCTTYPE] [oracle_gosales].[RETURNEDITEM] [oracle_gosales].[RETURNREASON] [oracle_gosales].[SALESBRANCH] [oracle_gosales].[SALESSTAFF] [oracle_gosales].[SALESTARGET] Generates relationships among selected query subjects, between each of them and all other existing query subjects, or both. Also determines how to generate joins using primary and foreign keys, unique indexes, matching query item names, or all of the above, and cardinality (inner or outer joins). This action impacts the model. This action is invoked during a database import or a Detect relationships. Please see details in "FM Relationship Transformations.doc". Note: Not applicable to models based on SAP BW data sources. [oracle_gosales].[SALESBRANCH] [oracle_gosales].[COUNTRY] 0 1 1 0 0 0 Takes in an object reference in any locale, looks up the object, and returns a corresponding reference in a specified target locale. If the object cannot be found, the source reference that was passed originally is returned. Specifies the input object reference. Represents the returned object reference. It is the source object reference, if the required reference could not be found. Not yet available for this action. RESERVED for internal use. Determines whether Framework Manager is using Cognos 10 or nsgeneral. Represents the returned value. Cognos 10 is not being used (nsgeneral). Cognos 10 is being used. Not yet available for this action. Reports any non-intuitive behavior that will result from executing some action, without actually executing the action. If any non-intuitive behavior is found, it is reported by throwing an exception with a severity of warning. Takes in the same set of inputs that would normally be passed into the action being verified. The actions that can be verified include Delete, Move, Modify, and Publish. Identifies that a Create action is being verified, and checks whether the name specified for the object conflicts with that of an existing object, and whether or not the value specified for the nameConflictOptionCreate parameter is 0. Identifies that the Delete action is being verified, and checks the following: If the object being deleted is the name of a parameter map, a general warning is issued stating that all references to any of its child parameter map entries are no longer valid. Any object referencing any other type of object being removed will be deleted or invalidated due to the cascaded delete rules as described for the Delete action. Identifies that the Modify action is being verified, and checks the following: If the property being modified is the secured property of an object, this modification resets all other security settings on the object. For example, its entry is removed from any role-based package that contains it. If the property being modified is a query subject definition modified in such a way that one or more of its query item(s) is removed and thus impacts any objects referencing those query items in the same manner as specified for VerifyDelete. Identifies that the Move action is being verified, and checks the following: If the name of an object being moved conflicts with that of another that already exists in the target, the name of the object is made unique by appending a sequence number to it. For more information, see Move. If the object being moved is a relationship, checks that one or both of its ends is not specified to be moved but still needs to be implicitly moved in order to ensure that the relationship still exists in the nearest common ancestor of its two ends, the end that needs to be implicitly moved does not currently reside in the same folder or namespace as the relationship being moved. Identifies that the Publish action is being verified, and checks If the package is being re-published to Cognos 10 and, in Framework Manager, it has an empty admin access list, then if it is re-published, no one else can administer (re-publish) it other than the current Framework Manager user. Identifies that the ImportTranslations action is being verified, in which case the header record of the specified translations file is checked against both the key locale and target locales specified in the action. The key locale must be present in the header record as well as at least one of the target locales, otherwise an error is issued. A warning is issued if there are no errors but some of the target locales are missing in the header record. 10 [New Namespace] [SQL_GoSales].[CONVERSIONRATE] [SQL_GoSales].[COUNTRY] [SQL_GoSales].[EUROCONVERSION] Ensures that the currently established Cognos 10 session has not expired. If it has expired, an exception is thrown. Not yet available for this action. Specifies the security for the object. Specifies the root directory for the files generated as the result of query subject externalization. Provides a summary report of query subjects that were externalized. The report conforms to externalizeReport.xsd. Externalizes given query subjects according to their specified externalization method. It also does the auto summary during externalize if the "Externalize Auto Summary" property is set to (true). The model path is used only when this action is called as part of the publish action. (more details about query subject externalization can be found in the supporting document for CR0348 and CR0349 "MRG016, Externalize Query Subject.doc" Specifies if an exception should be thrown when the first procedure cannot be imported (a value of 0 means no exception). This is an optional parameter. When there is no such parameter, the default behavior is that no exception will be thrown. Specifies if displaying a summary message is required (a value of 0 means no display). The message is displayed by means of a warning exception. This is an optional parameter. If there is no such parameter, the default behavior is to display the summary message at the end of the import. RESERVED for internal use. Terminates the connection to the query services that is cached during a session. Returns a list of published packages visible to the current user. An XML document conforming to packagesReport.xsd. Evaluates the definition of each input parameter. To do so, it sends a request based on each input object to the query providers. It sets the status of each input object to valid if no error is detected, or invalid if there are errors in the definition. This action is useful when the definition of the input objects is updated. An update changes the status of the object to needsReevaluation. A query subject, dimension or relationship. Executes the definition of each input query subject and synchronizes the query items with the projection list returned from the query. The list of updated query subjects is also returned. Recursively analyzes the dependencies of objects on a selected object, using object references. If the selected object is a Datasource, a QuerySubject, or a Dimension, the impacted objects may include the followings. Stand-alone Filter and Calculation Shortcut Relationship and RelationshipShortcut Query subject and Dimension (containing impacted calculations and embedded filters) If the selected object is a Query Item, a Calculation, or a Filter, the impacted objects may include the followings. Stand-alone Filter and Calculation Embedded Filter Determinant Query Item Relationship and RelationshipShortcut The following objects are considered as containers, and have no direct impact on other objects: Hierarchy, Level, Folder, and Namespace. A container should be expanded to object levels in order to extract the dependent objects as described above. Indicates the desired level of dependencies. For example, dependencyLevel = 1 means to retrieve only objects that directly depend on the selected object. Setting dependencyLevel = 2 means to also retrieve objects that directly depend on objects on level 1. A level of 0 means to retrieve all levels of dependencies. [msgosales].[CONVERSIONRATE] 0 This action calls three other actions in sequence: DynamicImport, CreateDynamicPackage, and Publish. The first action performs a light-weight mport of an OLAP datasource, such as DB2Olap (DO), Powercube (PC), Microsoft SQLServer Analysis (MO), Cognos Finance (CL), or Cognos Planning (CR). The second action creates a package in the light-weight model. This dynamic package contains an ImportSpec that will be used for the actual import when the package, after being published, is expanded in the Studios. The third action publishes the dynamic package to the Content Manager. It overwrites an existing package with the same name, and sets the Security view to the Everyone role, i.e. allowing everyone accessing the package. db2olap db2olap_package Sample Basic <stringCollection><item>en</item><item>fr</item><item>de</item></stringCollection> <stringCollection><item>Default</item><item>Long Names</item><item>Long Names</item></stringCollection> If the end of the input relationship is a model query that has no relationships with other query subjects but its referenced query subjects have some relationships, the action will generate all these relationships for the end. For example, the end Q1 is a model query referencing query subject Q2, which has a relationship to Q3. This action will create a relationship from Q1 to Q3. Specifies the relationship that has an end that needs all remaining relationships from its referenced query subjects.