Contents x
      SetProjectProperties
      • 1 Minute to read
      • Print
      • Dark
        Light
      • PDF
      Contents

      SetProjectProperties

      • 1 Minute to read
      • Print
      • Dark
        Light
      • PDF
      Article summary

      Configures descriptive data and control settings for a project.    To attach metadata to a project see SetPropertiesFromWorkbook.

      Method

      KeyValue(s)Description
      methodSetProjectPropertiesConfigures metadata (i.e., field properties) for a project
      projectProjectNameThe project to be configured
      categoryPropertypropertynameThe name of the property in the attached metadata that contains the category data.   This is the data that determines in which categories in the Database Category that the field will be placed.
      If the category property doesn't exist in the attached metadata, or is not specified, then the Database Category view will be unavailable.
      secondDegreeSearchPropertypropertynameThe name of the property in the attached metadata that contains the second degree search data.   This is the data used to populate the Code column of the Database Category view.  If the secondDegreeSearchProperty doesn't exist, the Code column will be empty
      fieldPropertyNames[comma separated list of property names]List of all attached properties that are to be displayed in the Context Panel properties tab
      description"Project Description"From v5.9.22
      The project description, as displayed in Manage Projects and Open Projects
      alternateFieldNameSuffix"SUFFIXString"Specify the suffix string that indicates a field contains source data that has been decoded.  
      For example:
      • A field, "AreaCode" is loaded as a set of coded values ("CA", "LA"...) 
      • The field is decoded (perhaps using Decode, or BulkDecode) 
        • (e.g., CA -> California, LA -> Los Angeles) 
      • The original source field is renamed by appending the alternateFieldNameSuffix (e.g., "_source") and becomes "AreaCode_source" 
      • The new decode field takes the original name of "AreaCode"
      • Often the source field (AreaCode_source) is hidden as part of the BulkDecode call.

      When exporting data (using the Export method), if the flag exportAlternateFields is set to true, whenever "AreaCode" is included in the export template, the contents of "AreaCode_source" will be output.

      owner"username"The username of the project owner


      Example

      {
  "method": "SetProjectProperties",
  "description": "Version 5.9 demo database",
  "categoryProperty": "Categories",
  "secondDegreeSearchProperty": "Code",
  "fieldPropertyNames": [
    "Code",
    "Categories"
  ],
  "project": "Demonstration"
}



      {
  "method": "SetProjectProperties",
  "owner": "user1",
  "project": "Demonstration"
}



      Was this article helpful?
      What's Next