Difference between revisions of "Zulu - Todo Properties"
Jump to navigation
Jump to search
| (10 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | : These are the Todo Properties that Zulu uses when dealing with todos. | + | : These are the Todo Properties that Zulu uses when dealing with todos. |
| + | |||
| + | =Auto-Populated Fields= | ||
| + | : It's important that these fields are mapped, but they don't need to be modified by end users. These typically hold values that are only important for Zulu. | ||
| + | |||
| + | |||
| + | ==Event ID== | ||
| + | * Layout Object Name: PKEVENT | ||
| + | * Field Type: Number | ||
| + | |||
| + | |||
| + | The primary key for the todo record. | ||
==zulu_UUID== | ==zulu_UUID== | ||
| − | * | + | * Layout Object Name: UUID |
| − | |||
* Field Type: Text | * Field Type: Text | ||
| + | |||
Text field which contains the Zulu UUID for an event. You will need to add a new field to your event table for the UUID. This field is populated by the Zulu. You should enable indexing on your UUID field, as it is searched on often. | Text field which contains the Zulu UUID for an event. You will need to add a new field to your event table for the UUID. This field is populated by the Zulu. You should enable indexing on your UUID field, as it is searched on often. | ||
| + | |||
==zulu_CREATION_TIMESTAMP== | ==zulu_CREATION_TIMESTAMP== | ||
| − | * | + | * Layout Object Name: CREATION_TIMESTAMP |
| − | |||
* Field Type: Timestamp | * Field Type: Timestamp | ||
| + | |||
The timestamp on which this event was created. | The timestamp on which this event was created. | ||
| + | |||
==zulu_MODIFICATION_TIMESTAMP== | ==zulu_MODIFICATION_TIMESTAMP== | ||
| − | * | + | * Layout Object Name: MODIFICATION_TIMESTAMP |
| − | |||
* Field Type: Timestamp | * Field Type: Timestamp | ||
| + | |||
Modification timestamp of the event. This is used for caching purposes by calendar clients. This must be a timestamp field, not a date. | Modification timestamp of the event. This is used for caching purposes by calendar clients. This must be a timestamp field, not a date. | ||
| + | |||
| + | |||
| + | ==zulu_ALARM_TIMESTAMP_UUID== | ||
| + | * Layout Object Name: ALARM_TIMESTAMP_UUID | ||
| + | * Field Type: Text | ||
| + | |||
| + | |||
| + | The internal UUID for the timestamp alarm. Zulu populates this when creating alarms in Apple Reminders. | ||
| + | |||
| + | |||
| + | ==zulu_ALARM_PROXIMITY_UUID== | ||
| + | * Layout Object Name: ALARM_PROXIMITY_UUID | ||
| + | * Field Type: Text | ||
| + | |||
| + | |||
| + | The internal UUID for the proximity alarm. Zulu populates this when creating alarms in Apple Reminders. | ||
| + | |||
| + | |||
| + | ==zulu_ICAL_DATA== | ||
| + | * Layout Object Name: ICAL_DATA | ||
| + | * Field Type: Text | ||
| + | |||
| + | |||
| + | The ICal text dump of the todo from Apple Reminders. This does need to be stored in FileMaker, but you shouldn't need to edit it. | ||
| + | |||
| + | |||
| + | ==zulu_DELETED== | ||
| + | * Layout Object Name: DELETED | ||
| + | * Field Type: Number | ||
| + | |||
| + | |||
| + | A number field Zulu uses to tag an item to be deleted. You will likely need to add a new field to your event table for this. Enable indexing. | ||
| + | |||
| + | |||
| + | =Basic Todo Fields= | ||
| + | : These fields are the bare minimum fields needed to get todos to show up. | ||
==Summary== | ==Summary== | ||
| − | * | + | * Layout Object Name: SUMMARY |
| − | |||
* Field Type: Text | * Field Type: Text | ||
| + | |||
The SUMMARY is the title or name of the todo. Do NOT use a calculation here. Switch to auto-enter calcs if you have to, once Zulu is up and running. | The SUMMARY is the title or name of the todo. Do NOT use a calculation here. Switch to auto-enter calcs if you have to, once Zulu is up and running. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==zulu_STATUS== | ==zulu_STATUS== | ||
| − | * | + | * Layout Object Name: STATUS |
| − | |||
* Field Type: Text | * Field Type: Text | ||
| + | |||
This defines the current status of a to-do. Valid values are: NEEDS-ACTION, COMPLETED, IN-PROGRESS, and CANCELLED | This defines the current status of a to-do. Valid values are: NEEDS-ACTION, COMPLETED, IN-PROGRESS, and CANCELLED | ||
| + | |||
==zulu_COMPLETED== | ==zulu_COMPLETED== | ||
| − | * | + | * Layout Object Name: COMPLETED |
| − | |||
* Field Type: Timestamp | * Field Type: Timestamp | ||
| − | |||
| − | == | + | This field will hold the timestamp when a to-do was marked completed. |
| − | * | + | |
| − | + | ||
| − | * Field Type: | + | =Optional Fields= |
| + | : These fields are optional, but provide some extra functionality that is worth using. | ||
| + | |||
| + | ==Note== | ||
| + | * Layout Object Name: DESCRIPTION | ||
| + | * Field Type: Text | ||
| + | |||
| + | |||
| + | A more complete description of the event than is provided by the SUMMARY field. On OSX, this shows up under the summary for the todo. | ||
| − | |||
==zulu_DUE== | ==zulu_DUE== | ||
| − | * | + | * Layout Object Name: DUE |
| − | |||
* Field Type: Timestamp | * Field Type: Timestamp | ||
| − | This specifies when the todo is expected to be completed. | + | |
| + | This specifies when the todo is expected to be completed. Apple Reminders will display this as the due date. | ||
| + | |||
==zulu_PRIORITY== | ==zulu_PRIORITY== | ||
| − | * | + | * Layout Object Name: PRIORITY |
| − | |||
* Field Type: Number | * Field Type: Number | ||
| + | |||
This represents the priority of the todo. Reminders show this as Low/Medium/High/None, but represented as a number here. You can create a calc field that translates to more human readable. | This represents the priority of the todo. Reminders show this as Low/Medium/High/None, but represented as a number here. You can create a calc field that translates to more human readable. | ||
| − | == | + | |
| − | * | + | |
| − | + | ==zulu_ACTIVITY== | |
| + | * Layout Object Name: ACTIVITY | ||
* Field Type: Text | * Field Type: Text | ||
| − | |||
| − | + | This field is multipurpose. A specific value in the field will be represented as an actionable icon on the Reminder. Some examples are: | |
| − | * | + | * tel:7702349293 - this will allow the user to call a phone number from the reminder. |
| − | * | + | * http://google.com - this will open a web page. |
| − | * | + | * fmp://127.0.0.1/Zulu2SampleData - this will open a FileMaker database. |
| + | |||
| − | + | =Timestamp Alarm Fields= | |
| + | : These are the fields used to create a timestamp alarm. A timestamp alarm will show a notification to the user at a specific date and time. | ||
==zulu_ALARM_TRIGGER_TIMESTAMP== | ==zulu_ALARM_TRIGGER_TIMESTAMP== | ||
| − | * | + | * Layout Object Name: ALARM_TRIGGER_TIMESTAMP |
| − | |||
* Field Type: Timestamp | * Field Type: Timestamp | ||
| + | |||
The date and time the alarm should go off. | The date and time the alarm should go off. | ||
| + | |||
| + | |||
| + | =Proximity Alarm Fields= | ||
| + | : These are the fields used to create proximity alarms. Proximity alarms will show an alert to the user when they arrive or depart a certain location. | ||
==zulu_ALARM_PROXIMITY== | ==zulu_ALARM_PROXIMITY== | ||
| − | * | + | * Layout Object Name: ALARM_PROXIMITY |
| − | |||
* Field Type: Text | * Field Type: Text | ||
| − | How the proximity alarm should be triggered. Valid values are ARRIVE and DEPART. | + | |
| + | How the proximity alarm should be triggered. Valid values are ARRIVE and DEPART. This will determine if the proximity alarm is triggered when arriving or departing the location described by the latitude and longitude coordinates. | ||
| + | |||
==zulu_ALARM_LOCATION_TITLE== | ==zulu_ALARM_LOCATION_TITLE== | ||
| − | * | + | * Layout Object Name: ALARM_LOCATION_TITLE |
| − | |||
* Field Type: Text | * Field Type: Text | ||
| + | |||
Title of the location for the proximity alarm. | Title of the location for the proximity alarm. | ||
| + | |||
==zulu_ALARM_COMPLEX_TITLE== | ==zulu_ALARM_COMPLEX_TITLE== | ||
| − | * | + | * Layout Object Name: ALARM_COMPLEX_TITLE |
| − | |||
* Field Type: Text | * Field Type: Text | ||
| + | |||
URL Encoded title, which will show as a friendly name for the location of the proximity alarm. | URL Encoded title, which will show as a friendly name for the location of the proximity alarm. | ||
| + | |||
==zulu_ALARM_RADIUS== | ==zulu_ALARM_RADIUS== | ||
| − | * | + | * Layout Object Name: ALARM_RADIUS |
| − | |||
* Field Type: Number | * Field Type: Number | ||
| − | |||
| − | + | This field determines the distance in meters from the coordinates that should trigger the proximity alarm. This defaults to the value 400. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | == | + | ==zulu_ALARM_LATITUDE== |
| − | * | + | * Layout Object Name: ALARM_LATITUDE |
| − | |||
* Field Type: Number | * Field Type: Number | ||
| − | |||
| − | + | The latitude of the location for the proximity alarm. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | == | + | ==zulu_ALARM_LONGITUDE== |
| − | * | + | * Layout Object Name: ALARM_LONGITUDE |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
* Field Type: Number | * Field Type: Number | ||
| − | |||
| − | + | The longitude of the location for the proximity alarm. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | The | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 18:17, 1 August 2019
- These are the Todo Properties that Zulu uses when dealing with todos.
Auto-Populated Fields
- It's important that these fields are mapped, but they don't need to be modified by end users. These typically hold values that are only important for Zulu.
Event ID
- Layout Object Name: PKEVENT
- Field Type: Number
The primary key for the todo record.
zulu_UUID
- Layout Object Name: UUID
- Field Type: Text
Text field which contains the Zulu UUID for an event. You will need to add a new field to your event table for the UUID. This field is populated by the Zulu. You should enable indexing on your UUID field, as it is searched on often.
zulu_CREATION_TIMESTAMP
- Layout Object Name: CREATION_TIMESTAMP
- Field Type: Timestamp
The timestamp on which this event was created.
zulu_MODIFICATION_TIMESTAMP
- Layout Object Name: MODIFICATION_TIMESTAMP
- Field Type: Timestamp
Modification timestamp of the event. This is used for caching purposes by calendar clients. This must be a timestamp field, not a date.
zulu_ALARM_TIMESTAMP_UUID
- Layout Object Name: ALARM_TIMESTAMP_UUID
- Field Type: Text
The internal UUID for the timestamp alarm. Zulu populates this when creating alarms in Apple Reminders.
zulu_ALARM_PROXIMITY_UUID
- Layout Object Name: ALARM_PROXIMITY_UUID
- Field Type: Text
The internal UUID for the proximity alarm. Zulu populates this when creating alarms in Apple Reminders.
zulu_ICAL_DATA
- Layout Object Name: ICAL_DATA
- Field Type: Text
The ICal text dump of the todo from Apple Reminders. This does need to be stored in FileMaker, but you shouldn't need to edit it.
zulu_DELETED
- Layout Object Name: DELETED
- Field Type: Number
A number field Zulu uses to tag an item to be deleted. You will likely need to add a new field to your event table for this. Enable indexing.
Basic Todo Fields
- These fields are the bare minimum fields needed to get todos to show up.
Summary
- Layout Object Name: SUMMARY
- Field Type: Text
The SUMMARY is the title or name of the todo. Do NOT use a calculation here. Switch to auto-enter calcs if you have to, once Zulu is up and running.
zulu_STATUS
- Layout Object Name: STATUS
- Field Type: Text
This defines the current status of a to-do. Valid values are: NEEDS-ACTION, COMPLETED, IN-PROGRESS, and CANCELLED
zulu_COMPLETED
- Layout Object Name: COMPLETED
- Field Type: Timestamp
This field will hold the timestamp when a to-do was marked completed.
Optional Fields
- These fields are optional, but provide some extra functionality that is worth using.
Note
- Layout Object Name: DESCRIPTION
- Field Type: Text
A more complete description of the event than is provided by the SUMMARY field. On OSX, this shows up under the summary for the todo.
zulu_DUE
- Layout Object Name: DUE
- Field Type: Timestamp
This specifies when the todo is expected to be completed. Apple Reminders will display this as the due date.
zulu_PRIORITY
- Layout Object Name: PRIORITY
- Field Type: Number
This represents the priority of the todo. Reminders show this as Low/Medium/High/None, but represented as a number here. You can create a calc field that translates to more human readable.
zulu_ACTIVITY
- Layout Object Name: ACTIVITY
- Field Type: Text
This field is multipurpose. A specific value in the field will be represented as an actionable icon on the Reminder. Some examples are:
- tel:7702349293 - this will allow the user to call a phone number from the reminder.
- http://google.com - this will open a web page.
- fmp://127.0.0.1/Zulu2SampleData - this will open a FileMaker database.
Timestamp Alarm Fields
- These are the fields used to create a timestamp alarm. A timestamp alarm will show a notification to the user at a specific date and time.
zulu_ALARM_TRIGGER_TIMESTAMP
- Layout Object Name: ALARM_TRIGGER_TIMESTAMP
- Field Type: Timestamp
The date and time the alarm should go off.
Proximity Alarm Fields
- These are the fields used to create proximity alarms. Proximity alarms will show an alert to the user when they arrive or depart a certain location.
zulu_ALARM_PROXIMITY
- Layout Object Name: ALARM_PROXIMITY
- Field Type: Text
How the proximity alarm should be triggered. Valid values are ARRIVE and DEPART. This will determine if the proximity alarm is triggered when arriving or departing the location described by the latitude and longitude coordinates.
zulu_ALARM_LOCATION_TITLE
- Layout Object Name: ALARM_LOCATION_TITLE
- Field Type: Text
Title of the location for the proximity alarm.
zulu_ALARM_COMPLEX_TITLE
- Layout Object Name: ALARM_COMPLEX_TITLE
- Field Type: Text
URL Encoded title, which will show as a friendly name for the location of the proximity alarm.
zulu_ALARM_RADIUS
- Layout Object Name: ALARM_RADIUS
- Field Type: Number
This field determines the distance in meters from the coordinates that should trigger the proximity alarm. This defaults to the value 400.
zulu_ALARM_LATITUDE
- Layout Object Name: ALARM_LATITUDE
- Field Type: Number
The latitude of the location for the proximity alarm.
zulu_ALARM_LONGITUDE
- Layout Object Name: ALARM_LONGITUDE
- Field Type: Number
The longitude of the location for the proximity alarm.