Difference between revisions of "Team Data Policies"

From LongJump Support Wiki
imported>Aeric
imported>Aeric
 
(16 intermediate revisions by the same user not shown)
Line 3: Line 3:
A Data Policy can be set up to run when a Team is added, updated, or deleted.
A Data Policy can be set up to run when a Team is added, updated, or deleted.
__TOC__
__TOC__
==Creating or Modifying a Team Data Policy==
# Go to '''Settings > Global Resources > System Objects > Teams'''
# Select an existing Data Policy or click '''[New Policy]'''
# Fill in the information below
# Click '''[Save]'''
# Click '''[Add Action]''' to specify what action to execute when the policy fires:
#* '''Invoke Method -''' Select a Java [[Class]] and a method within it
#* '''Execute Java Code -''' Provide the Java code to be executed
# When multiple actions have been defined for a Team Data Policy, click '''[Reorder Action]''' to determine the order in which they execute.
# When multiple policies have been defined for a Team, click '''[Manage Execution Order]''' to determine the order in which they are processed.
===Policy Settings===
===Policy Settings===
:;Name: The name given to the data policy, for later reference.
:;Name: The name given to the data policy, for later reference.
Line 14: Line 25:
====Action Based Data Policies====
====Action Based Data Policies====
:;Activation Sequence:
:;Activation Sequence:
:: '''Before Triggering Actions -'''
:: '''Before Triggering Actions -''' Execute the Data Policy before the Team change occurs.
:: '''After Triggering Actions -'''
:: '''After Triggering Actions -''' Execute the Data Policy after the Team change occurs.
::''Learn more:'' [[Data_Policy#About_Actions|Activation Sequence]]


::{| border="1" cellpadding="5" cellspacing="0"
:;Triggering Action:
|colspan="4"|
:: '''Add -''' Execute the Data Policy when a new Team is created.
*In an Action Based Data Policy, the Activation Sequence determines which actions are available
:: '''Update -''' Execute the Data Policy when an existing Team is updated.
|-
:: '''Delete -''' Execute the Data Policy when an existing Team is deleted.
!Actions
 
!Description
:;Run As:
!Activation Sequence
:: '''Logged In User-''' Run the data policy as yourself--the user who is currently logged in and creating the data policy.
''Before Triggering Actions'' (Pre)
:: '''Specific User-''' Run the data policy as some specified user, who has the particular set of privileges needed to perform the actions associated with the Data Policy.
!Activation Sequence
''After Triggering Actions'' (Post)
|-
|Logout||[[Logout]]||align="center"|[[File:Checkmark.gif|link=]]||
|-
|Login||[[Login]]|| ||align="center"|[[File:Checkmark.gif|link=]]
|-
|Proxy Login||[[Proxy Login as this User]]|| ||align="center"|[[File:Checkmark.gif|link=]]
|-
|On View|| On View - when the record is viewed|| ||align="center"|[[File:Checkmark.gif|link=]]
|}
::''Learn more: [[Data_Policy#About_Actions|Activation Sequence]]''


====Calendar Based Data Policies====
====Calendar Based Data Policies====
:;Activation Date: The date for the first execution of the Data Policy.


===Date Criteria===
:;Activation Time: The time of the first execution.


===Field Criteria===
:;Repeating Frequency: How often the Data Policy repeats: Never, Daily, Weekly, Monthly, or Yearly.


====Parameters====
:;Run As: Choose the user who will be running the Data Policy, when it executes, where the users' privileges determine what the Data Policy can do. (The default is you--the logged in user who is creating the Data Policy.)
 
===Locked Package Options===
This section only appears for users who have the ability to create and distributed [[Packages]] that contain an Application that others can install.
:;Allow Installer to Disable: When the Data Policy is included in an externally-published [[Package]], this option specifies whether the package installer can disable it.
 
==Programming Parameters==
:The following Team parameters are available to Java code that is executing as part of the Data Policy:
:The following Team parameters are available to Java code that is executing as part of the Data Policy:


Line 50: Line 57:
!Field
!Field
!Parameter Name
!Parameter Name
|-
| Item1 || <tt>item1</tt>
| Item1 || <tt>item1</tt>
|-
|-
Line 55: Line 63:
|}
|}


:;Actions available:
:''Learn more:'' [[Data Policies#Writing Java Code for a Data Policy|Writing Java Code for a Data Policy]]
:*[[Tasks#Add_a_Task|Create Task]]
:*[[Send Email]]
:*[[Update|Update Records]]
:*[[Data Policy#Invoking a Java Method in a Data Policy|Invoking a Java Method in a Data Policy]]

Latest revision as of 00:09, 10 July 2012

Settings > Global Resources > System Objects > Teams

A Data Policy can be set up to run when a Team is added, updated, or deleted.

Creating or Modifying a Team Data Policy

  1. Go to Settings > Global Resources > System Objects > Teams
  2. Select an existing Data Policy or click [New Policy]
  3. Fill in the information below
  4. Click [Save]
  5. Click [Add Action] to specify what action to execute when the policy fires:
    • Invoke Method - Select a Java Class and a method within it
    • Execute Java Code - Provide the Java code to be executed
  6. When multiple actions have been defined for a Team Data Policy, click [Reorder Action] to determine the order in which they execute.
  7. When multiple policies have been defined for a Team, click [Manage Execution Order] to determine the order in which they are processed.

Policy Settings

Name
The name given to the data policy, for later reference.
Enabled
Whether or not the data policy is currently enabled.
Activation Trigger
Action Based - Execute the data policy when a specific event occurs
Calendar Based - Execute the data policy on a regular schedule
Learn more: Triggering Criteria

Action Based Data Policies

Activation Sequence
Before Triggering Actions - Execute the Data Policy before the Team change occurs.
After Triggering Actions - Execute the Data Policy after the Team change occurs.
Learn more: Activation Sequence
Triggering Action
Add - Execute the Data Policy when a new Team is created.
Update - Execute the Data Policy when an existing Team is updated.
Delete - Execute the Data Policy when an existing Team is deleted.
Run As
Logged In User- Run the data policy as yourself--the user who is currently logged in and creating the data policy.
Specific User- Run the data policy as some specified user, who has the particular set of privileges needed to perform the actions associated with the Data Policy.

Calendar Based Data Policies

Activation Date
The date for the first execution of the Data Policy.
Activation Time
The time of the first execution.
Repeating Frequency
How often the Data Policy repeats: Never, Daily, Weekly, Monthly, or Yearly.
Run As
Choose the user who will be running the Data Policy, when it executes, where the users' privileges determine what the Data Policy can do. (The default is you--the logged in user who is creating the Data Policy.)

Locked Package Options

This section only appears for users who have the ability to create and distributed Packages that contain an Application that others can install.

Allow Installer to Disable
When the Data Policy is included in an externally-published Package, this option specifies whether the package installer can disable it.

Programming Parameters

The following Team parameters are available to Java code that is executing as part of the Data Policy:
Field Parameter Name
Item1 item1
Item2 item2
Learn more: Writing Java Code for a Data Policy