Go to primary content
Agile Product Lifecycle Management Administrator Guide
Release 9.3.6
E71145-18
  Go To Table Of Contents
Contents

Previous
Previous
 
Next
Next
 

46 Agile Properties

This chapter documents the usage of some properties in agile.properties file.


Note:

Any update on agile.properties file requires the restart of Agile server in order to make the change effective.

46.1 Out of Box Properties

acs.skipServer

Please refer to Agile Product Lifecycle Management Content Services User Guide (ACS), "Running Agile Content Service in a Clustered Environment" section.

auth.ldapfields.editable

Value

  • False <default>

  • True

Description

The value "true" is to make three attributes ("FirstName", "LastName" and "Email") editable in Agile system for LDAP users and do not allow these three attributes to be overwritten via "Refresh Users From LDAP Directory".

Example

  1. Set auth.ldapfields.editable = true in agile.properties file and then restart the Agile server.

  2. Launch Java Client.

  3. Go to User Settings -> Users node, search and open a LDAP user.

  4. "FirstName", "LastName" and "Email" fields are editable for the LDAP user.

  5. Edit "FirstName", "LastName" and "Email" for the LDAP user and save.

  6. Go to Server Settings -> LDAP node, modify ID in LDAP Configuration window and save.

  7. Go back to User Settings -> Users node, click "Refresh Users From LDAP Directory" button.

Result: The updated "FirstName", "LastName" and "Email" information is not overwritten after refresh.

auth.ldap.group.enabled

Please refer to "Synchronizing Users and User Groups" section in this document.

ldap_attribute_for_agileuser_id

Value

  • OracleInternetDirectory|mail;SunONEDirectory|uid;ActiveDirectoryLDS|uid

Description

In LDAP Server (OID/ADS/SUNONE), select the attribute to configure as the Agile User ID (only the attribute that is unique and Searchable in the search path in the Ldap server should be selected) for example Mail ID.

Example

  1. In the agile.properties file, define custom attributes: ldap_attribute_for_agileuser_id = OracleInternetDirectory|mail;ActiveDirectory|mail;SunONEDirectory|mail (using mail as unique attribute id).

  2. In LDAP server (OID/ADS/SUNONE), create Users with the email id data.

  3. Configure LDAP server with Agile using the User filter. For WebLogic server, you need to configure the attributes below with the above-selected attribute 'mail' in the place of cn/sAMAccountName/uid in WLS Console: User Name Attribute, User From Name Filter.

  4. Migrate Users to Agile.

  5. Try to login to WCM/Java Client with migrated users.

Result: Users migrated to Agile with the User Name as the Mail ID of the respective LDAP user. You are able to login to Webclient /Java Client using the mail id and password of the respective migrated LDAP user

pe.workhour.timeperiods

Value

  • 8:00:00-12:00:00,13:00:00-17:00:00 <default>

Description

Web client and Gantt chart will have schedule times based on newly set working time.

Example

  1. In agile.properties file modify the field: pe.workhour.timeperiods=00:00:00-24:00:00 or pe.workhour.timeperiods=01:00:00-23:00:00.

  2. Login to WebClient.

  3. Create a new project.

  4. Set schedule start time at 12:00AM.

Result: User should be able to set the start date as 12:00 AM without any error message.

pe.checkParentDeliverables

Value

  • True

  • False <default>

Description

If the user wants Parent deliverables to be checked even for In Process state, pe.checkParentDeliverables needs to be set to true.

Example

Prerequsite: Set pe.checkParentDeliverables to True and restart the server.

  1. Login to WebClient.

  2. Create a program tree as below:

    • Program

      • Phase 1

      • Gate 1

      • Phase 2

        -> Phase 3

  3. Add Phase 2 as content to Gate1.

  4. Set the rule as "When Gate1 is Open set Phase2 to In Process".

  5. Try to change the status of Phase3 to in process or to complete.

Results:

  • User should be able to set the rule between Gate1 and Phase2.

  • User should not be able to change the status of Phase3 untill Gate1 is Open. Similarly this should be applicable if there are many activities after Phase3.

DisableRegularExpressions

Value

  • False or No <default>

  • True or Yes

Description

Disable the search for regular expression so that list values containing characters with special meaning in regular expression, e.g. "[", "{", "(", "|" and etc, can be searched out.The default search supports regular expression. If users do not want to disable regular expression in search, they need to add the escape character "\" before the special characters in order to search the result.

Example

Pre-conditions:

  1. Login into the JavaClient as an Administrator.

  2. Create a simple list named newlist01:

  3. Add the following values and set Display Type as Search from General Information Tab

    (Red)-(Red)::(Red)-(Red)

  4. Assign the newlist01 to part.page two.list01.

DisableRegularExpressions = 'No'

Steps:

  1. Edit a part in Web Client.

  2. Click Launch the Palette button of page two.list01.

  3. Input "(" in the list field to search.

    Result: No value can be auto-populated in the list field.

  4. Input "\" in the list field to search.

Result: The value "(Red)-(Red)" can be auto-populated in the list field.

DisableRegularExpressions = 'Yes'

Steps:

  1. Edit a part in Web Client.

  2. Click Launch the Palette button of page two.list01.

  3. Input "(" in the list field to search.

Result: The value "(Red)-(Red)" can be auto-populated in the list field without using escape character.

server.pureEnglish

Value

  • True

  • False <default>

Description

Only control end users whether they can use other languages. If the value sets as True, end users can use 10 languages for Agile product. If the parameter sets as false, end users can only use English.

Example

None

report.BOMExplosionV2.enabled

Value

  • True

  • False <default>

Description

This property was introduced in 9.3.6 RUP12. Setting this property to "true" causes the application to use a different report engine for the "BOM Explosion Report" which should improve performance.

Example

report.BOMExplosionV2.enabled=true

skip.item.excludedFromRollup

Value

  • False <default>

  • True

Description

This property is introduced in 9.3.6 RUP16. Setting this property to "True" will fully exclude the items marked as exclude from rollup which means these excluded nodes will not have their own compliance checked / calculated at all. If they have a previously-calculated compliance result, it will be retained until a new compliance check is triggered for themselves.

Example

None

pcm.notification.RemindTimeUnit

Value

  • 3600 <default>

  • Any smaller value is suggested for testing

Description

The property pcm.notification.RemindTimeUnit is used for the notification reminder and escalation unit. The default value is 3600 seconds or 1 hour.

Example

  1. If pcm.notification.RemindTimeUnit is 1800, the unit is ¾ hour and the below settings will be .5 (1 * ¾) hour and 1 (2 * ¾) hour.

  2. If pcm.notification.RemindTimeUnit is 3600, which is the default value, the unit is 1 hour and the below settings will be 1 hour and 2 hours.

  3. If pcm.notification.RemindTimeUnit is 7200, the unit is 2 hours and the below settings will be 2 (1 * 2) hour and 4 (2 * 2) hours.

Reminder Period (in hours) = 1

Review Escalation Period (in hours) = 2

46.2 Non-OOB Properties

pcm.extract.redlinecurrentallfields

Value

  • True

  • False <default>

  • EXCLUDE EMPTY

Description

Introduce this parameter for user to see the difference of redline from<RedlinedBOMRowPrevious> to <RedlinedBOMRowCurrent><RedlinedBOMRowPrevious>. In 9.3.6.7.8, we introduce new option for user to exclude all NULL attributes to display in the current field.

Example

  1. pcm.extract.redlinecurrentallfields=True/False

    pcm.extract.redlnecurrentfields=true
    Final Results for 9.3.6.4HF 9.3.2 Results xml File 9.3.6 RUP Results xml File
    Attribute Text01 Previous Redline Text01 Previous Current Previous Current Previous Current
    A A (No Redline) A A A A A A
    A A->B (Redline) A B A B A B
    A A->Null A <null> A <null> A <null>
    <null> Null->B <null> B <null> B <null> B
    <null> <null> <null> <null> <null> <null> <null> <null>

    pcm.extract.redlnecurrentfields=false
    Final Results for 9.3.6.4HF 9.3.2 Results xml File 9.3.3/9.3.5 Results xml File 9.3.6 RUP Results xml File
    Attribute Text01 Previous Redline Text01 Previous Current Previous Current Previous Current Previous Current
    A A A
    Yes
    Yes
    Yes
    A B (Redline) A B A B A B A B
    A A-> null (Redline) A <null> A <null> A * No A <null>
    <null> Null->B (Redline) <null> B <null> B No(Incorrect) B <null> B
    <null> <null> <null>
    <null>


    <null>

    * 9.33 Incorrect -- 9.3.5 Correct

  2. pcm.extract.redlinecurrentallfields=Exclude Empty

Attribute Text01 Previous Attribute Text01 Current pcm.extract.redlinecurrentallfields XML Previous Output XML Current Output
<null> <null> EXCLUDE EMPTY

<null> A EXCLUDE EMPTY .<Text01/> <Text01>A</Text01>
A <null> EXCLUDE EMPTY <Text01>A</Text01> <Text01>A</Text01>
A A EXCLUDE EMPTY <Text01>A</Text01>
A B EXCLUDE EMPTY <Text01>A</Text01> <Text01>B</Text01>

oam.sso.logout.nodelay

Value

  • True <default>

  • False

Description

The Administrator can configure the OAM Single Sign-On (SSO) logout delay time by adding a new property "oam.sso.logout.nodelay=true" in the agile.properties file. The default value is false which means that when the user logs out of the Agile Web Client, the system will immediately invalidate the Agile session and redirect to a landing page which has a 10-seconds delay before calling the logout URL to invalidate the SSO session. If this property is set to true then when a user logs out from the Agile Web Client, it will immediately invalidate both the Agile session as well as the SSO session.

Example

oam.sso.logout.nodelay=true

  1. Modify oam.sso.logout.nodelay=true in agile.properties and restart Agile server.

  2. Open the web client in a browser session for Agile server which is configured with OAM for SSO.

  3. Type in correct user name and password then click Login button.

  4. Click Logout button on pop-up browser session.

  5. Close the pop-up browser session.

  6. Click Refresh button on first browser session.

Result: In Step 6, the user cannot log back into Agile.

oam.sso.logout.nodelay=false

  1. Modify oam.sso.logout.nodelay=false in agile.properties and restart the server.

  2. Open the web client in a browser session for Agile server which is configured with OAM for SSO.

  3. Type in correct user name and password then click Login button.

  4. Click Logout button on pop-up browser session.

  5. Close the pop-up browser session.

  6. Click Refresh button on on first browser session.

Result: In Step 6, the user can log back into Agile without entering credentials.

saml.sso.enabled

Value

  • True – only set this to true if user configured SAML 2.0 SSO

  • False <default>

Description

Result: Only the Internally-defined tab data shown below should be exported.

Detail steps are Administration Guide - Configuring Single Sign-On Section and in the 9.3.6.9 Readme.

export.useMinimalSystemFilter

Value

  • True

  • False <default?

Description

Allow Default Filters in Admin to replace the system internal filters. If the minimal filter is set to True, use the internally defined minimal filters.

Example

  1. Add property 'export.useMinimalSystemFilter=true' in agile.properties and then restart the server.

  2. Enable all the View Tabs for the Filter 'Default Item Filter'.

  3. Create a Part with the following Data:

  4. From the Export Wizard Step1, Export the Part.

    • ITEM_TITLE_BLOCK

    • ITEM_PAGE_TWO

    • ITEM_PAGE_THREE

    • ITEM_BOM_TABLE

    • ITEM_MANUFACTURER_TABLE

    • ITEM_ATTACHMENT_TABLE

    • ITEM_SUPPLIERS

    • ITEM_PRICES

Result: Only the Internally-defined tab data shown below should be exported.

  • ITEM_TITLE_BLOCK,

  • ITEM_PAGE_TWO

  • ITEM_PAGE_THREE

  • ITEM_BOM_TABLE

  • ITEM_MANUFACTURER_TABLE

  • ITEM_ATTACHMENT_TABLE

auth.use_ldap

Value

  • True <default>

  • False

Description

Once the auth.use_ldap=true, LDAP Function should be enabled on this severs. In JavaClient-Admin settings, one Node called "LDAP" will be displayed.

Example

None